Nesta página, você verá como criar painéis usando a API Cloud Monitoring. Para cada exemplo, a definição do painel em JSON e o painel correspondente são mostrados.
O Cloud Monitoring também fornece um conjunto selecionado de definições de painel no GitHub. É possível instalar essas definições no projeto do Google Cloud como painéis personalizados. Para informações sobre esse repositório e como instalar esses painéis, consulte Instalar painéis de amostra.
Quando usar a API
A API Cloud Monitoring oferece uma maneira de gerenciar vários painéis ao mesmo tempo. Embora você possa usar o console do Google Cloud para gerenciar seus painéis, pode ser mais fácil usar a API para gerenciar seus painéis personalizados em massa.
Você também precisa usar a API quando quiser adicionar o widget de marcador em branco ao seu painel.
Como usar o MQL ou PromQL com a API
Use o método dashboards.create para criar painéis. Você transmite para o método da API um objeto Dashboard, que contém
uma entrada para cada widget exibido pelo painel.
Quando um widget exibe dados de série temporal, como um widget de gráfico, a entrada dele no objeto Dashboard contém um objeto TimeSeriesQuery.
Esse objeto descreve os dados da série temporal a serem representados em um gráfico. Para especificar esses dados, use um filtro do Monitoring, uma consulta MQL ou uma consulta do PromQL:
Para usar filtros do Monitoring, preencha o campo
timeSeriesField. Os exemplos nesta página usam filtros do Cloud Monitoring.Para usar uma consulta MQL, preencha o campo
timeSeriesQueryLanguage. Para mais informações, consulte Como criar gráficos.Para usar uma consulta PromQL, preencha o campo
prometheusQuery. Para informações gerais, consulte PromQL no Cloud Monitoring.
Layouts de painel
Esta seção contém informações sobre os diferentes layouts de painel disponíveis.
Painel em GridLayout
Este painel mostra um GridLayout com três 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"
}
}
}
]
}
}
O painel é semelhante a este exemplo:
Painel em MosaicLayout
Este painel mostra um MosaicLayout com dois 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"
}
}
}
}
]
}
}
O painel é semelhante a este exemplo:
Painel em RowLayout
Este painel exibe um RowLayout com três 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"
}
}
]
}
]
}
}
O painel é semelhante a este exemplo:
Painel em ColumnLayout
Este painel exibe um ColumnLayout com três
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"
}
}
]
}
]
}
}
O painel é semelhante a este exemplo:
Painéis com Widgets
Painel com um XyChart
Este painel mostra um painel com um simples XyChart. Se
você já usou o console do Google Cloud para criar gráficos em painéis, esses gráficos
são instâncias do widget XyChart.
Semelhante à funcionalidade fornecida no console do Google Cloud, a API oferece opções para alterar o PlotType ou configurar os modos de visualização do gráfico.
{
"dashboardFilters": [],
"displayName": "Example line chart",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"title": "VM Instance - CPU utilization [MEAN]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_MEAN",
"groupByFields": [
"resource.label.\"zone\""
],
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24
}
]
}
}
O gráfico no painel é semelhante ao seguinte exemplo:
A próxima seção ilustra como criar um widget de gráfico da Análise de dados de registros, como exibir um limite em um gráfico e como configurar se o gráfico usará o eixo Y à esquerda, o eixo Y à direita ou ambos.
Painel com um gráfico da Análise de dados de registros
Este painel mostra um painel com um gráfico da Análise de dados de registros. O JSON de amostra contém uma consulta SQL.
{
"displayName": "Example Log Analytics",
"dashboardFilters": [],
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"width": 24,
"height": 16,
"widget": {
"title": "Sample Log Analytics chart",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"breakdowns": [],
"dimensions": [
{
"column": "location",
"columnType": "STRING",
"maxBinCount": 5,
"sortColumn": "location",
"sortOrder": "SORT_ORDER_ASCENDING"
}
],
"measures": [
{
"aggregationFunction": {
"parameters": [],
"type": "count"
},
"column": ""
}
],
"plotType": "STACKED_BAR",
"targetAxis": "Y1",
"timeSeriesQuery": {
"opsAnalyticsQuery": {
"queryHandle": "",
"sql": "SELECT\n CAST(JSON_VALUE(resource.labels.location) AS STRING) AS location,\n severity,\nFROM\n `TABLE`"
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
}
}
]
},
"labels": {}
}
O gráfico no painel é semelhante ao seguinte exemplo:
Painel com um XyChart e um limite
Este painel mostra um painel com um XyChart básico,
um limite e o eixo Y esquerdo configurado.
{
"dashboardFilters": [],
"displayName": "Example line with threshold",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"title": "VM Instance - CPU utilization [MEAN]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_MEAN",
"groupByFields": [
"resource.label.\"zone\""
],
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [
{
"label": "",
"targetAxis": "Y1",
"value": 0.2
}
],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24
}
]
}
}
No exemplo anterior, o JSON especifica o uso do eixo Y esquerdo porque ele contém uma estrutura y2Axis. No campo targetAxis, use "Y1" para o eixo Y direito e "Y2" para o eixo Y esquerdo. Se você omitir o campo targetAxis, o eixo Y à direita será usado.
O gráfico nesse painel é semelhante ao exemplo a seguir:
É possível criar gráficos que exibem vários tipos de métricas e que usam os eixos esquerdo e direito. O exemplo anterior ilustrou um gráfico com um único tipo de métrica, ou seja, há um elemento na matriz dataSets.
Quando você cria um gráfico com dois tipos de métrica, a matriz dataSets contém dois elementos, e cada elemento especifica o respectivo targetAxis.
Painel com um XyChart com um STACKED_AREA PlotType
Este painel mostra um XyChart com um STACKED_AREA
PlotType.
{
"dashboardFilters": [],
"displayName": "Example stacked area",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"title": "VM Instance - CPU utilization [MEAN]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "STACKED_AREA",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_MEAN",
"groupByFields": [
"resource.label.\"zone\""
],
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24
}
]
}
}
O gráfico no painel é semelhante ao seguinte exemplo:
Painel com um XyChart com um STACKED_BAR PlotType
Este painel mostra um XyChart com um STACKED_BAR
PlotType.
{
"dashboardFilters": [],
"displayName": "Example stacked bar",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"title": "VM Instance - CPU utilization [MEAN]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "STACKED_BAR",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_MEAN",
"groupByFields": [
"resource.label.\"zone\""
],
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24
}
]
}
}
O painel é semelhante a este exemplo:
Painel com um Scorecard básico
Este painel mostra um Scorecard sem um medidor ou gráfico. O exemplo mostra a utilização da CPU do Compute Engine e a visão geral
tem dois limites. Um limite usa a cor amarela para indicar que
a utilização da CPU está acima de 70%, a outra usa vermelho para indicar que
a utilização da CPU está acima de 90%.
Como a utilização atual da CPU é inferior aos limites especificados, a cor é verde.
{
"dashboardFilters": [],
"displayName": "Example-basic scorecard",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 8,
"widget": {
"scorecard": {
"thresholds": [
{
"color": "YELLOW",
"direction": "ABOVE",
"label": "",
"value": 0.7
},
{
"color": "RED",
"direction": "ABOVE",
"label": "",
"value": 0.9
}
],
"timeSeriesQuery": {
"outputFullDuration": true,
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_MEAN",
"groupByFields": [],
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
},
"title": "VM Instance - CPU utilization [MEAN]"
},
"width": 16
}
]
}
}
O painel é semelhante a este exemplo:
Painel com Scorecard com GaugeView
Este painel adiciona um medidor à visão geral básica no exemplo anterior.
O objeto GaugeView pode especificar um limite superior e um inferior para definir o intervalo de valores a ser exibido no medidor. Como a visão geral mostra valores de 0 a 1, esses limites superior e inferior são razoáveis. Para adicionar o medidor, adicione o seguinte ao JSON para a visão geral básica:
"gaugeView": {
"lowerBound": 0,
"upperBound": 1,
},
Veja a seguir a especificação completa do painel modificado: o valor atual está abaixo dos limites, que são coloridos adequadamente no medidor.
{
"dashboardFilters": [],
"displayName": "Example-Gauge",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 8,
"widget": {
"scorecard": {
"gaugeView": {
"lowerBound": 0,
"upperBound": 1
},
"thresholds": [
{
"color": "YELLOW",
"direction": "ABOVE",
"label": "",
"value": 0.7
},
{
"color": "RED",
"direction": "ABOVE",
"label": "",
"value": 0.9
}
],
"timeSeriesQuery": {
"outputFullDuration": true,
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_MEAN",
"groupByFields": [],
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
},
"title": "VM Instance - CPU utilization [MEAN]"
},
"width": 16
}
]
}
}
O gráfico nesse painel é semelhante ao exemplo a seguir:
Painel com Scorecard com SparkChartView
Esse painel substitui o medidor no exemplo anterior por um minigráfico.
O objeto SparkChartView pode criar gráficos de linhas ou de barras em uma visão geral.
Este exemplo usa uma linha. Se o valor não violar um limite, ele ficará verde. Para adicionar o gráfico, substitua o objeto JSON gaugeView no gráfico anterior pelo seguinte:
"sparkChartView": {
"sparkChartType": "SPARK_LINE"
},
A visão geral é semelhante ao exemplo a seguir:
Painel com um widget PieChart
Os painéis podem exibir dados usando um gráfico de pizza. Cada série temporal contribui com uma fatia. Os gráficos de pizza não mostram dados ao longo do tempo, eles mostram apenas o valor mais recente.
Todos os gráficos de pizza são especificados pelo widget PieChart.
Para configurar o gráfico para exibir a soma das medidas mais recentes, defina o campo chartType como DONUT. Caso contrário, defina esse campo como o
valor de PIE.
"pieChart": {
"chartType": "DONUT",
},
O exemplo a seguir configura um painel com dois gráficos de pizza, com um deles configurado como um donut:
{
"dashboardFilters": [],
"displayName": "Example Pie Donut",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"pieChart": {
"chartType": "DONUT",
"dataSets": [
{
"minAlignmentPeriod": "60s",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_RATE"
},
"filter": "metric.type=\"compute.googleapis.com/instance/disk/read_bytes_count\" resource.type=\"gce_instance\"",
"secondaryAggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_MEAN"
}
}
}
}
]
},
"title": "VM Instance - Disk read bytes [MEAN]"
},
"width": 24
},
{
"height": 16,
"widget": {
"pieChart": {
"chartType": "PIE",
"dataSets": [
{
"minAlignmentPeriod": "60s",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_RATE"
},
"filter": "metric.type=\"compute.googleapis.com/instance/disk/read_bytes_count\" resource.type=\"gce_instance\"",
"secondaryAggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_MEAN"
}
}
}
}
]
},
"title": "VM Instance - Disk read bytes [MEAN]"
},
"width": 24,
"xPos": 24
},
]
}
}
Conforme mostrado na captura de tela a seguir, os dois widgets exibem dados como um gráfico de pizza, com um deles exibindo a soma dos valores mais recentes:
Painel com um widget TimeSeriesTable
Os painéis podem exibir dados em um formato tabular, em que há uma linha para cada série temporal monitorada. As tabelas não mostram dados ao longo do tempo. Elas mostram apenas o valor mais recente.
Todas as tabelas são especificadas pelo widget TimeSeriesTable:
Para configurar o número máximo de linhas a serem exibidas, defina o campo
pickTimeSeriesFilter. Por exemplo, para exibir apenas as duas séries temporais com o maior valor médio nos últimos 10 minutos, inclua o seguinte:"pickTimeSeriesFilter": { "direction": "TOP", "numTimeSeries": 2, "rankingMethod": "METHOD_MEAN" },Se você omitir o campo
pickTimeSeriesFilter, a tabela exibirá no máximo 300 linhas.Para configurar como a tabela exibe os dados, use o campo
metricVisualization:- Para exibir apenas um valor como "25%", omita esse campo ou defina o
valor como
"NUMBER". Quando você usa essa configuração, o console do Google Cloud exibe o widget como um widget de Tabela. - Para exibir o valor e um indicador visual do valor em comparação com o
intervalo de valores possíveis, defina o valor desse campo como
"BAR". Quando você usa essa configuração, o console do Google Cloud exibe o widget como um widget de lista principal.
- Para exibir apenas um valor como "25%", omita esse campo ou defina o
valor como
Para configurar quais colunas são exibidas, use o campo
columnSettings. O exemplo a seguir resulta em uma tabela com duas colunas, uma chamadaLatest Value, que é obrigatória, e a outra intituladaName (from instance_id):"columnSettings": [ { "column": "Name (from instance_id)", "visible": true } ],Se você omitir o campo
columnSettings, a tabela exibirá uma coluna para cada rótulo.
O exemplo a seguir mostra um painel com um widget de Tabela e um de Lista principal:
{
"dashboardFilters": [],
"displayName": "Example",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"timeSeriesTable": {
"columnSettings": [
{
"column": "value",
"visible": false
}
],
"dataSets": [
{
"minAlignmentPeriod": "60s",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
}
],
"metricVisualization": "NUMBER"
},
"title": "Table"
},
"width": 24,
"yPos": 16
},
{
"height": 16,
"widget": {
"timeSeriesTable": {
"columnSettings": [
{
"column": "value",
"visible": false
}
],
"dataSets": [
{
"minAlignmentPeriod": "60s",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\""
}
}
}
],
"metricVisualization": "BAR"
},
"title": "Top List"
},
"width": 24
}
]
}
}
Conforme mostrado na captura de tela a seguir, os dois widgets exibem dados em forma de tabela e contêm uma barra de filtro. No entanto, os dois widgets são pré-configurados para mostrar colunas diferentes e representar o valor numérico de maneira diferente:
As colunas da tabela correspondem aos rótulos. Cada linha corresponde a uma série temporal.
Painel com um widget Text
Este exemplo mostra um painel simples com um widget Text.
{
"dashboardFilters": [],
"displayName": "DB2+TE",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
...
{
"height": 16,
"widget": {
"text": {
"content": "# Support information\n\n\nContact information: my-support-team@example.com\nOnline help: [Playbooks](https://example.com)\n\n",
"format": "MARKDOWN",
"style": {
"backgroundColor": "",
"fontSize": "FS_LARGE",
"horizontalAlignment": "H_LEFT",
"padding": "P_EXTRA_SMALL",
"textColor": "",
"verticalAlignment": "V_TOP"
}
}
},
"width": 24,
"yPos": 14
}
]
}
}
O widget de texto é parecido com este exemplo:
Painel com um widget AlertChart
Este painel mostra um painel com um widget
AlertChart:
{
"category": "CUSTOM",
"displayName": "Alert chart example",
"mosaicLayout": {
"columns": 12,
"tiles": [
{
"height": 4,
"widget": {
"alertChart": {
"name": "projects/my-project/alertPolicies/14205854094151528373"
}
},
"width": 6,
}
]
}
}
Diferentemente de outros widgets do painel, não é possível especificar um título ou um filtro de métrica para esses widgets. Em vez disso, especifique o nome do recurso para uma política de
alertas. A última entrada no campo name é o identificador da política de alertas.
O gráfico no painel é semelhante ao seguinte exemplo:
Neste exemplo, a política de alertas está monitorando o uso da CPU de duas máquinas virtuais diferentes. A linha tracejada mostra o limite de condição, que é definido como 50%. O ícone verde com o rótulo No incidents
indica que não há incidentes abertos para a política de alertas. Se você colocar o ponteiro no ícone de incidentes, uma caixa de diálogo será aberta com links para a política de alertas subjacente.
Painel com um widget ErrorReportingPanel
Este painel mostra um painel com um widget
ErrorReportingPanel:
{
"dashboardFilters": [],
"displayName": "Error reporting widget",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"errorReportingPanel": {
"projectNames": [
"projects/my-project"
],
"services": [],
"versions": []
},
"title": "Error Reporting Panel"
},
"width": 24,
}
]
}
}
Recomendamos que você configure a altura de um painel de relatório de erros para pelo menos 16 unidades e a largura dele para pelo menos 24 unidades. No exemplo anterior, o widget tem 16 unidades de altura e 24 de largura.
O painel "Error Reporting" mostra os grupos de erros do projeto selecionado, e ele pode restringir os grupos de erros a um tipo de recurso, serviço ou versão específicos de um serviço. O exemplo a seguir ilustra um painel de relatório de erros:
Painel com um widget IncidentList
Este painel mostra um painel com um widget
IncidentList:
{
"category": "CUSTOM",
"dashboardFilters": [],
"displayName": "Incident widget",
"labels": {},
"mosaicLayout": {
"columns": 12,
"tiles": [
{
"height": 5,
"widget": {
"incidentList": {
"monitoredResources": [],
"policyNames": []
},
"title": "Incidents"
},
"width": 8,
"xPos": 0,
"yPos": 0
}
]
}
}
O exemplo anterior define o campo title como Incidents e configura o widget para exibir todos os incidentes de recursos do tipo gce_instance.
Ao configurar esse widget, é possível selecionar várias políticas de alertas ou vários tipos de recursos.
O widget de incidentes no painel é parecido com o seguinte exemplo:
Painel com um widget LogsPanel
Este painel mostra um painel com um widget:
LogsPanel.
{
"category": "CUSTOM",
"displayName": "Logs Panel",
"mosaicLayout": {
"columns": 12,
"tiles": [
{
"height": 4,
"widget": {
"logsPanel": {
"filter": "",
"resourceNames": [
"projects/012012012012"
]
},
"title": "Logs Panel"
},
"width": 6,
"xPos": 0,
"yPos": 0
}
]
}
}
Recomendamos que você configure a altura de um painel de registros para que seja de pelo menos três unidades e a largura de pelo menos quatro unidades. No exemplo anterior, o widget tem uma altura de quatro unidades e uma largura de seis unidades.
O painel de registros exibe os registros dos projetos do Google Cloud listados
no campo resourceNames. O exemplo anterior especifica apenas um projeto.
No entanto, é possível incluir vários projetos nessa lista.
O painel de registros é semelhante ao exemplo a seguir:
Para informações sobre solução de problemas, consulte A chamada de API para criar um painel com um painel de registros falha.
Painel com um widget CollapsibleGroup
Este painel mostra um painel com um widget:
CollapsibleGroup.
{
"category": "CUSTOM",
"displayName": "Group testing",
"mosaicLayout": {
"columns": 12,
"tiles": [
{
"height": 4,
"widget": {
"collapsibleGroup": {
"collapsed": false
},
"title": "My group"
},
"width": 12,
"xPos": 0,
"yPos": 0
},
{
"height": 4,
"widget": {
"title": "VM Instance - CPU utilization [MEAN]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"apiSource": "DEFAULT_CLOUD",
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_NONE",
"perSeriesAligner": "ALIGN_MEAN"
},
"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\"",
"secondaryAggregation": {
"alignmentPeriod": "60s",
"crossSeriesReducer": "REDUCE_NONE",
"perSeriesAligner": "ALIGN_NONE"
}
}
}
}
],
"thresholds": [],
"timeshiftDuration": "0s",
"yAxis": {
"label": "y1Axis",
"scale": "LINEAR"
}
}
},
"width": 6,
"xPos": 0,
"yPos": 0
}
]
}
}
No exemplo anterior, o widget de grupo recolhível contém um único gráfico que mostra a utilização da CPU de uma instância de VM. Os widgets de grupo recolhíveis
são uma linha inteira de uma tabela. Um widget é incluído em um grupo quando as
especificações de posição e altura (x,y) dele incluem a posição (x,y) do widget. No exemplo anterior, o grupo está na posição
de (0,0) e a altura é 4. O xyChart está na posição de (0,0). Portanto,
ele está incluído no grupo. No entanto, se a posição dele for alterada para (0,5), ele será excluído do grupo. Por fim, quando
a posição (x,y) de um widget faz com que ele seja incluído no grupo, a
altura do widget do grupo que pode ser recolhido pode ser expandida.
Para incluir um widget de grupo em um painel, ele precisa ter um
MosaicLayout.
O widget de grupo recolhível é parecido com este exemplo:
Painel com um widget SingleViewGroup
Um widget SingleViewGroup exibe um membro de um
grupo por vez. Você especifica os gráficos e outros widgets que são membros do grupo. Além disso, você controla qual widget do grupo é exibido
usando um menu no widget SingleViewGroup.
Este painel mostra um painel com um widget SingleViewGroup:
{
"dashboardFilters": [],
"displayName": "Example",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"singleViewGroup": {},
"title": "Untitled group"
},
"width": 24,
"yPos": 16
},
{
"height": 16,
"widget": {
"title": "VM Instance - Disk read bytes [RATE]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_RATE"
},
"filter": "metric.type=\"compute.googleapis.com/instance/disk/read_bytes_count\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24,
"yPos": 16
},
{
"height": 16,
"widget": {
"title": "VM Instance - Disk write bytes [RATE]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_RATE"
},
"filter": "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24,
"yPos": 16
}
]
}
}
Como mostrado no exemplo anterior, a matriz tiles contém um
objeto SingleViewGroup. No entanto, esse objeto não especifica quais objetos
contém. Em vez disso, a associação no objeto SingleViewGroup é determinada
pelos valores dos campos width e yPos. Objetos com valores para os campos
width e yPos que correspondem aos
valores do objeto SingleViewGroup estão contidos no
objeto SingleViewGroup. No exemplo anterior, o objeto SingleViewGroup
contém dois gráficos.
Painel com um widget SectionHeader
Um widget SectionHeader cria um divisor horizontal no
seu painel e uma entrada no índice do
painel. É possível personalizar a entrada no índice e incluir mais informações no widget. Também é possível configurar o widget
para adicionar um divisor ao índice após a entrada do cabeçalho da seção.
Esse painel mostra um painel com um único gráfico e um widget SectionHeader:
{
"dashboardFilters": [],
"displayName": "Example",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"title": "VM Instance - Disk write bytes [RATE]",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"minAlignmentPeriod": "60s",
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"alignmentPeriod": "60s",
"perSeriesAligner": "ALIGN_RATE"
},
"filter": "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" resource.type=\"gce_instance\""
}
}
}
],
"thresholds": [],
"yAxis": {
"label": "",
"scale": "LINEAR"
}
}
},
"width": 24,
"yPos": 4
},
{
"height": 4,
"widget": {
"sectionHeader": {
"dividerBelow": true,
"subtitle": "Instance metrics"
},
"title": "Metrics"
},
"width": 48
}
]
}
}
No objeto SectionHeader, o valor do campo title é exibido no widget e no índice. O valor do campo
subtitle é exibido apenas pelo widget. Quando o valor de
dividerBelow for true, um divisor será adicionado ao sumário.
Painel com um widget de SLO
Este painel mostra um painel com um widget de SLO:
{
"dashboardFilters": [],
"displayName": "Example",
"labels": {},
"mosaicLayout": {
"columns": 48,
"tiles": [
{
"height": 16,
"widget": {
"title": "SLO Error Budget: 99.5% - Distribution Cut - Calendar month",
"xyChart": {
"chartOptions": {
"mode": "COLOR"
},
"dataSets": [
{
"breakdowns": [],
"dimensions": [],
"legendTemplate": "Remaining error requests before SLO is burned",
"measures": [],
"plotType": "LINE",
"targetAxis": "Y1",
"timeSeriesQuery": {
"timeSeriesFilter": {
"aggregation": {
"perSeriesAligner": "ALIGN_NEXT_OLDER"
},
"filter": "select_slo_budget(\"projects/Project_Number/services/SERVICE_ID/serviceLevelObjectives/SLO_ID\")",
},
"unitOverride": "1"
}
}
],
"thresholds": []
}
},
"width": 24
}
]
}
}
Como mostrado no JSON anterior, os gráficos de SLO são representados como
objetos XyChart. Esses objetos especificam todos
os campos de agregação, limites e o
valor do campo filter é um seletor de série temporal. Para mais informações
sobre esses seletores, consulte Como recuperar dados de SLO.
O widget de SLO é semelhante ao exemplo a seguir:
Painel com um widget em branco
Este exemplo mostra um painel com um widget de marcador vazio.
O valor do campo displayName aparece no widget.
{
"displayName": "Demo Dashboard",
"gridLayout": {
"widgets": [
{
"blank": {}
}
]
}
}
O painel é semelhante a este exemplo:
Painéis com filtros permanentes
Para ver um exemplo de painel com filtro permanente, consulte Filtros do painel.