Tutorial: Obtendo a taxa de erro de um serviço

Uma solicitação curl para esse endpoint não requer parâmetros de consulta nem carga útil de solicitação.

curl -XPOST https://{tenant}-{unit}.instana.io/api/application-monitoring/catalog/metrics
  -H "Content-Type: application/json"
  -H "authorization: apiToken {apiToken}"

A resposta é um catálogo de métricas, que é uma lista de tipos de métricas compatíveis. Você pode percorrê-la para encontrar os sites metricId e aggregation para os dados métricos que deseja extrair para um serviço.

[
    {
        "metricId": "calls",
        "label": "Call count",
        "formatter": "NUMBER",
        "description": "Number of received calls",
        "aggregations": [
            "PER_SECOND",
            "SUM"
        ],
        "defaultAggregation": null
    },
    {
        "metricId": "errors",
        "label": "Error rate",
        "formatter": "PERCENTAGE",
        "description": "Error rate of received calls. A value between 0 and 1.",
        "aggregations": [
            "MEAN"
        ],
        "defaultAggregation": "MEAN"
    },
    // More metric types...
]

Considere um dos seguintes tipos de métricas do catálogo que retornou à seção anterior. Duas informações que você deve recuperar da entrada do catálogo de métricas:

• metricId - um identificador exclusivo para o tipo de métrica
• aggregation - agregações estatísticas disponíveis para a métrica. Um tipo de métrica pode ter uma ou mais agregações.

Para o tipo de métrica "taxa de erro" desejado, você pode ver que há apenas uma agregação disponível: "MEAN".

Você pode testar esse endpoint na linha de comando. É possível determinar rapidamente se você tem as informações corretas para fazer a solicitação HTTP REST e as permissões de acesso adequadas. Ele também fornece a carga útil da resposta, que você pode investigar.

curl -XPOST https://{tenant}-{unit}.instana.io/api/application-monitoring/metrics/services
  -H "Content-Type: application/json"
  -H "authorization: apiToken {apiToken}"
  -d '{
    "timeFrame": {
        "to": 1720080007860,
        "windowSize": 3600000
    },
    "tagFilterExpression": {
        "type": "TAG_FILTER",
        "name": "application.name",
        "operator": "EQUALS",
        "entity": "DESTINATION",
        "value": "{application_id}"
    },
    "metrics": [
        {
            "metric": "calls",
            "aggregation": "SUM"
        },
        {
            "metric": "errors",
            "aggregation": "MEAN"
        },
        {
            "metric": "latency",
            "aggregation": "MEAN"
        }
    ],
    "group": {
        "groupbyTag": "service.name",
        "groupbyTagEntity": "DESTINATION"
    }
  }'

Para automatizar programaticamente a recuperação de uma lista de serviços para um aplicativo específico, você pode tentar a seguinte função Python que usa a biblioteca requests para buscar todos os serviços de um aplicativo especificado que usa o endpoint GET service metrics.

Se você não tiver um ambiente Python configurado em seu computador local, poderá tentar essa função usando um Jupyter Notebook no Google Colab, que fornece um ambiente no navegador para escrever e executar o código Python. Para usar o Google Colab, você precisa de uma conta Google. Use Google Colab para criar um Jupyter Notebook no Colab.

# import the required libraries
import requests
import json

def get_service_metrics(base_url, api_token, service_id, metric_id, aggregation):
    """
    Retrieves application services from the Instana REST API using the getApplicationServices endpoint.

    Args:
        base_url (str): The base URL of the Instana API. Defaults to 'https://{tenant}-{unit}.instana.io'. 
        api_token (str): The API token for authentication.
        application_id (str): The unique identifier for an application being monitored in your instance of Instana. 

    Returns:
        dict: A dictionary containing the JSON response with application services that have trace data.
              Returns None if the request fails.
    """

    # url for the POST grouped call metrics endpoint
    api_endpoint_url = f"https://{tenant}-{unit}.instana.io/api/application-monitoring/metrics/services"

    headers = {
        "Content-Type": "application/json",
        "Authorization": f"apiToken {api_token}"
    }

    # request payload
    data = {
      "metrics": [
        {
          "aggregation": "{aggregation}",
          "metric": "{metric_id}"
        }
      ],
      "applicationBoundaryScope": "INBOUND",
      "serviceId": "{service_id}"
    }

    try:
        response = requests.request("POST", api_endpoint_url, headers=headers, json=data)
        response.raise_for_status()  # Raise error for bad status codes

        return response.json()  # Return JSON response

    except requests.exceptions.RequestException as e:
        print(f"Error: {e}")
        return None  # Return None on error

BASE_URL = "{your_tenant}-{your_unit}.instana.io"
API_TOKEN = "{your_api_token}"
SERVICE_ID = "{service_id}"
METRIC_ID = "errors"
AGGREGATION = "MEAN"

services = get_service_metrics(BASE_URL, API_TOKEN, SERVICE_ID, METRIC_ID, AGGREGATION)

if services is not None:
     print(services)

Depois de fazer a chamada à API, você poderá receber uma resposta JSON semelhante ao que é mostrado no seguinte bloco de código:

  {
    "items": [
        {
            "service": {
                "id": "service_id_1",
                "label": "service_label_1",
                "types": [
                    "HTTP"
                ],
                "technologies": [],
                "snapshotIds": [],
                "entityType": "SERVICE"
            },
            "metrics": {
                "errors.mean": [
                    [
                        1720629650000,
                        0.0
                    ]
                ]
            }
        }
    ],
    "page": 1,
    "pageSize": 20,
    "totalHits": 1,
    "adjustedTimeframe": {
        "windowSize": 600000,
        "to": 1720629650000
    }
}