apmmetric.get

Descrição

integer/array apmmetric.get(object parameters)

O método permite recuperar pontos de dados de métricas de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações da função de usuário. Consulte Funções de usuário para obter mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método aceita os seguintes parâmetros.

Parâmetro Tipo Descrição
time_from timestamp Retorna somente os pontos de dados cujo horário seja igual ou posterior ao horário especificado.

Comportamento do parâmetro:
- obrigatório
time_till timestamp Retorna somente os pontos de dados cujo horário seja anterior ao horário especificado.

Comportamento do parâmetro:
- obrigatório
types integer/array Retorna somente os pontos de dados dos tipos especificados.

Consulte a página do objeto de métrica APM para obter uma lista dos tipos de métricas compatíveis.
with_flags_on integer Retorna somente os pontos de dados que tenham todos os sinalizadores especificados definidos.
Para especificar vários sinalizadores, use a soma de seus valores.
with_flags_off integer Retorna somente os pontos de dados que não tenham nenhum dos sinalizadores especificados definido.
Para especificar vários sinalizadores, use a soma de seus valores.
resource_attributes object/array Retorna somente os pontos de dados com os atributos de recurso especificados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Uma matriz vazia retorna todos os pontos de dados.

Valores possíveis de operador:
0 - (padrão) Contém;
1 - É igual a;
2 - Não contém;
3 - Não é igual a;
4 - Existe;
5 - Não existe.
resource_attributes_evaltype integer Método de avaliação das condições em resource_attributes.

Valores possíveis:
0 - (padrão) E/Ou;
2 - Ou.
scope_attributes object/array Retorna somente os pontos de dados com os atributos de escopo especificados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Uma matriz vazia retorna todos os pontos de dados.

Valores possíveis de operador:
0 - (padrão) Contém;
1 - É igual a;
2 - Não contém;
3 - Não é igual a;
4 - Existe;
5 - Não existe.
scope_attributes_evaltype integer Método de avaliação das condições em scope_attributes.

Valores possíveis:
0 - (padrão) E/Ou;
2 - Ou.
attributes object/array Retorna somente os pontos de dados com os atributos especificados.
Formato: [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Uma matriz vazia retorna todos os pontos de dados.

Valores possíveis de operador:
0 - (padrão) Contém;
1 - É igual a;
2 - Não contém;
3 - Não é igual a;
4 - Existe;
5 - Não existe.
attributes_evaltype integer Método de avaliação das condições em attributes.

Valores possíveis:
0 - (padrão) E/Ou;
2 - Ou.
filter object Retorna somente os resultados que correspondam exatamente ao filtro especificado.

Aceita um objeto cujas chaves são nomes de propriedades e cujos valores são um único valor ou uma matriz de valores a serem comparados.

Propriedades compatíveis: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags.
search object Retorna os resultados que correspondam ao padrão especificado (sem distinção entre maiúsculas e minúsculas).

Aceita um objeto cujas chaves são nomes de propriedades e cujos valores são strings a serem pesquisadas. Se nenhuma opção adicional for especificada, será realizada uma pesquisa LIKE "%…%".

Propriedades compatíveis: resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit.
sortfield string/array Ordena o resultado pelas propriedades especificadas.

Valores possíveis: type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix.
offset integer Número de registros a ignorar antes de retornar o resultado.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
excludeSearch boolean
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Retorna um dos seguintes:

  • um array de objetos;
  • a quantidade de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando pontos de dados do histograma

Recupere o ponto de dados mais recente da métrica de histograma http.server.request.duration do serviço zabbix-frontend.

Solicitação:

{
    "jsonrpc": "2.0",
    "method": "apmmetric.get",
    "params": {
        "output": ["metric_name", "metric_unit", "time_unix", "count", "sum", "min", "max", "explicit_bounds", "bucket_counts", "exemplars"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "types": 2,
        "filter": {
            "service_name": "zabbix-frontend",
            "metric_name": "http.server.request.duration"
        },
        "sortfield": "time_unix",
        "sortorder": "DESC",
        "limit": 1
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "metric_name": "http.server.request.duration",
            "metric_unit": "s",
            "time_unix": "1790852390000000000",
            "count": "1842",
            "sum": "412.773",
            "min": "0.0061",
            "max": "1.098",
            "explicit_bounds": ["0.005", "0.05", "0.1", "0.25", "0.5", "1"],
            "bucket_counts": ["0", "211", "904", "512", "167", "41", "7"],
            "exemplars": [
                {
                    "traceid": "dee625f33cb0994e86c5cd4640e3b09c",
                    "spanid": "3f8b2c6d1e9a7054",
                    "value": "1.098",
                    "time_unix": "1790850513439147623",
                    "filtered_attributes": {}
                }
            ]
        }
    ],
    "id": 1
}

Veja também

Fonte

CApmMetric::get() em ui/include/classes/api/services/CApmMetric.php.