Paneles y diseños de muestra

En esta guía, se ilustran opciones de configuración del panel adicional que puedes crear con la API de Cloud Monitoring. Para obtener ejemplos adicionales, consulta Paneles instalables.

Cuándo usar la API

La API de paneles te ofrece una forma de administrar muchos paneles a la vez. Si bien puedes usar Google Cloud Console a fin de administrar tus paneles, es posible que te resulte más fácil usar la API para administrar tus paneles personalizados de forma masiva.

También debes usar la API si deseas agregar los widgets de marcador de posición en blanco, Text o Scorecard a tu panel.

Diseños del panel

Panel en GridLayout

En este panel se muestra un GridLayout con tres widgets.

{
  "displayName": "Grid Layout Example",
  "gridLayout": {
    "columns": "2",
    "widgets": [
      {
        "title": "Widget 1",
        "xyChart": {
          "dataSets": {
            "timeSeriesQuery": {
              "timeSeriesFilter": {
                "filter": "metric.type=\"agent.googleapis.com/nginx/connections/accepted_count\"",
                "aggregation": {
                  "perSeriesAligner": "ALIGN_RATE"
                }
              },
              "unitOverride": "1"
            },
            "plotType": "LINE"
          },
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          }
        }
      },
      {
        "text": {
          "content": "Widget 2"
        }
      },
      {
        "title": "Widget 3",
        "xyChart": {
          "dataSets": {
            "timeSeriesQuery": {
              "timeSeriesFilter": {
                "filter": "metric.type=\"agent.googleapis.com/nginx/connections/accepted_count\"",
                "aggregation": {
                  "perSeriesAligner": "ALIGN_RATE"
                }
              },
              "unitOverride": "1"
            },
            "plotType": "STACKED_BAR"
          },
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          }
        }
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un diseño de cuadrícula

Panel en MosaicLayout

En este panel se muestra un MosaicLayout con dos widgets.

{
  "displayName": "Mosaic Layout Example",
  "mosaicLayout": {
    "columns": 12,
    "tiles": [
      {
        "xPos": 2,
        "yPos": 2,
        "width": 7,
        "height": 2,
        "widget": {
          "title": "CPU utilization in us-central1-a",
          "scorecard": {
            "timeSeriesQuery": {
              "timeSeriesFilter": {
                "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" resource.label.zone=\"us-central1-a\"",
                "aggregation": {
                  "perSeriesAligner": "ALIGN_MEAN",
                  "crossSeriesReducer": "REDUCE_MAX"
                }
              },
              "unitOverride": "1"
            },
            "gaugeView": {
              "upperBound": 1.5
            },
            "thresholds": [
              {
                "value": 0.8,
                "color": "YELLOW",
                "direction": "ABOVE"
              },
              {
                "value": 1,
                "color": "RED",
                "direction": "ABOVE"
              }
            ]
          }
        }
      },
      {
        "xPos": 1,
        "yPos": 5,
        "width": 4,
        "height": 4,
        "widget": {
          "title": "My Chart",
          "xyChart": {
            "dataSets": [
              {
                "timeSeriesQuery": {
                  "timeSeriesFilter": {
                    "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
                    "aggregation": {
                      "perSeriesAligner": "ALIGN_MEAN",
                      "crossSeriesReducer": "REDUCE_MAX",
                      "groupByFields": [
                        "resource.label.zone"
                      ]
                    }
                  },
                  "unitOverride": "'1'"
                },
                "plotType": "LINE",
                "minAlignmentPeriod": "60s"
              }
            ],
            "yAxis": {
              "label": "y1Axis",
              "scale": "LINEAR"
            }
          }
        }
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un diseño de mosaico

Panel en RowLayout

En este panel, se muestra un RowLayout con tres widgets.

{
  "displayName": "Row Layout Example",
  "rowLayout": {
    "rows": [
      {
        "weight": "1",
        "widgets": [
          {
            "text": {
              "content": "Widget 1",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "Widget 2",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "Widget 3",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un diseño de fila

Panel en ColumnLayout

En este panel, se muestra un ColumnLayout con tres widgets.

{
  "displayName": "Column Layout Example",
  "columnLayout": {
    "columns": [
      {
        "weight": "1",
        "widgets": [
          {
            "text": {
              "content": "Widget 1",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "Widget 2",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "Widget 3",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un diseño de columnas

Paneles con Widgets

Panel con un XyChart

Aquí se muestra un panel con un XyChart básico. Si alguna vez usaste Google Cloud Console para crear gráficos en paneles, esos gráficos son instancias del widget XyChart.

Al igual que la funcionalidad que se proporciona en Cloud Console, la API brinda opciones a fin de cambiar PlotType o para configurar los modos de visualización del gráfico.

{
  "displayName": "Demo dashboard",
  "gridLayout": {
    "widgets": [
      {
        "title": "Sample line chart",
        "xyChart": {
          "dataSets": [
            {
              "timeSeriesQuery": {
                "timeSeriesFilter": {
                  "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
                  "aggregation": {
                    "perSeriesAligner": "ALIGN_MEAN",
                    "crossSeriesReducer": "REDUCE_MAX",
                    "groupByFields": [
                      "resource.label.zone"
                    ]
                  }
                },
                "unitOverride": "1"
              },
              "plotType": "LINE"
            }
          ],
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          },
          "chartOptions": {
            "mode": "COLOR"
          }
        }
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

XyChart de ejemplo

Panel con un XyChart con un STACKED_AREA PlotType

En este panel se muestra un XyChart con un STACKED_AREA PlotType.

{
  "displayName": "Demo dashboard",
  "gridLayout": {
    "widgets": [
      {
        "title": "Sample stacked-area chart",
        "xyChart": {
          "dataSets": [
            {
              "timeSeriesQuery": {
                "timeSeriesFilter": {
                  "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
                  "aggregation": {
                    "perSeriesAligner": "ALIGN_MEAN",
                    "crossSeriesReducer": "REDUCE_MAX",
                    "groupByFields": [
                      "resource.label.zone"
                    ]
                  }
                },
                "unitOverride": "1"
              },
              "plotType": "STACKED_AREA"
            }
          ],
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          },
          "chartOptions": {
            "mode": "COLOR"
          }
        }
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

XyChart de ejemplo con un trazado de área apilada

Panel con un XyChart con un STACKED_BAR PlotType

En este panel se muestra un XyChart con un STACKED_BAR PlotType.

{
  "displayName": "Demo Dashboard",
  "gridLayout": {
    "widgets": [
      {
        "title": "My First Chart",
        "xyChart": {
          "dataSets": [
            {
              "timeSeriesQuery": {
                "timeSeriesFilter": {
                  "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
                  "aggregation": {
                    "perSeriesAligner": "ALIGN_MEAN",
                    "crossSeriesReducer": "REDUCE_MAX",
                    "groupByFields": [
                      "resource.label.zone"
                    ]
                  }
                },
                "unitOverride": "1"
              },
              "plotType": "STACKED_BAR"
            }
          ],
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          },
          "chartOptions": {
            "mode": "COLOR"
          }
        }
      },
    ]
  }
}

El panel es similar al siguiente ejemplo:

XyChart de ejemplo con un trazado de barras apiladas

Panel con un Scorecard básico

En este panel, se muestra un Scorecard sin un indicador o minigráfico. Muestra el uso de CPU de Compute Engine y tiene dos límites, uno que usa el color amarillo para indicar que el uso de CPU supera el 70% y otro en rojo que indica que el uso de CPU supera el 90%.

Debido a que el uso actual de la CPU se encuentra por debajo de los límites especificados, se considera aprobado.

{
  "displayName": "Unadorned scorecard",
  "gridLayout": {
    "widgets": [
      {
        "title": "Compute Engine CPU utilization",
        "scorecard": {
          "timeSeriesQuery": {
            "timeSeriesFilter": {
              "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
              "aggregation": {
                "perSeriesAligner": "ALIGN_MEAN",
                "crossSeriesReducer": "REDUCE_MAX",
              }
            },
            "unitOverride": "1"
          },
          "thresholds": [
            {
              "color": "RED",
              "direction": "ABOVE",
              "label": "Danger",
              "value": 0.9,
            },
            {
              "color": "YELLOW",
              "direction": "ABOVE",
              "label": "Warning",
              "value": 0.7,
            }
          ]
        }
      },
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un widget de cuadro de evaluación

Panel con un Scorecard con GaugeView

Este panel agrega un indicador al cuadro de evaluación básico del ejemplo anterior. El objeto GaugeView puede especificar un límite superior y un límite inferior para especificar el rango de valores que se mostrarán en el indicador. Dado que el cuadro de evaluación muestra valores de 0 a 1, esos son límites superiores y inferiores razonables. Si deseas agregar el indicador, agrega lo siguiente al JSON para el cuadro de evaluación básico:

          "gaugeView": {
            "lowerBound": 0,
            "upperBound": 1,
          },

A continuación, se muestra la especificación completa y modificada del panel: el valor actual está por debajo de los límites, que aparece con el color adecuado en el indicador.

{
  "displayName": "Gauge scorecard",
  "gridLayout": {
    "widgets": [
      {
        "title": "Compute Engine CPU utilization",
        "scorecard": {
          "timeSeriesQuery": {
            "timeSeriesFilter": {
              "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
              "aggregation": {
                "perSeriesAligner": "ALIGN_MEAN",
                "crossSeriesReducer": "REDUCE_MAX",
              }
            },
            "unitOverride": "1"
          },
          "gaugeView": {
            "lowerBound": 0,
            "upperBound": 1,
          },
          "thresholds": [
            {
              "color": "RED",
              "direction": "ABOVE",
              "label": "Danger",
              "value": 0.9,
            },
            {
              "color": "YELLOW",
              "direction": "ABOVE",
              "label": "Warning",
              "value": 0.7,
            }
          ]
        }
      },
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un widget de cuadro de evaluación con GaugeView

Panel con un Scorecard con SparkChartView

Este panel reemplaza el indicador del ejemplo anterior por un minigráfico. El objeto SparkChartView puede crear gráficos de líneas o gráficos de barras en un cuadro de evaluación. En este ejemplo, se usa una línea. Mientras el valor no infrinja un umbral, será verde. Para agregar la minilínea, reemplaza el objeto JSON gaugeView del gráfico anterior por lo siguiente:

          "sparkChartView": {
            "sparkChartType": "SPARK_LINE"
          },

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un widget de cuadro de evaluación con SparkChartView

Panel con un widget Text

En este ejemplo, se muestra un panel sencillo con un widget Text.

{
  "displayName": "Demo Dashboard"
  "gridLayout": {
    "widgets": [
      {
        "text" {
          "content": "Hello World"
        }
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un widget de texto

Panel con un widget en blanco

En este ejemplo, se muestra un panel sencillo con un widget de marcador de posición vacío. Ten en cuenta que solo aparece el displayName del panel en el widget.

{
  "displayName": "Demo Dashboard",
  "gridLayout": {
    "widgets": [
      {
        "blank": {}
      }
    ]
  }
}

El panel es similar al siguiente ejemplo:

Panel de ejemplo con un widget en blanco