Esercitazione: Ottenere il tasso di errore di un servizio

Una richiesta di tipo " curl " a questo endpoint non richiede né parametri di query né payload.

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

La risposta è un catalogo metrico, ovvero un elenco dei tipi di metrica supportati. Puoi scorrere l'elenco per individuare i metricId campi aggregation relativi ai dati metrici che desideri estrarre per un servizio.

[
    {
        "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...
]
 

Si consideri uno dei seguenti tipi di metrica presenti nel catalogo riportato nella sezione precedente. Due informazioni che devi ricavare dalla voce del catalogo delle metriche:

• metricId - un identificatore unico per il tipo di metrica
• aggregation - Aggregazioni statistiche disponibili per la metrica. Un tipo di metrica può avere una o più aggregazioni.

Per il tipo di metrica "tasso di errore" desiderato, come puoi vedere è disponibile una sola aggregazione: "MEDIA".

È possibile testare questo endpoint dalla riga di comando. Puoi verificare rapidamente se disponi delle informazioni corrette per effettuare la richiesta REST all' HTTP e e delle autorizzazioni di accesso necessarie. Ti fornisce inoltre il payload della risposta, che puoi analizzare.

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"
    }
  }'
 

Per automatizzare a livello di programmazione il recupero di un elenco di servizi per un'applicazione specifica, è possibile provare la seguente funzione Python, che utilizza la requests libreria per recuperare tutti i servizi relativi a un'applicazione specificata tramite l'endpoint GET delle metriche di servizio.

Se sul tuo computer locale non hai configurato un ambiente Python, puoi provare questa funzione utilizzando un Jupyter Notebook su Google Colab, che offre un ambiente direttamente nel browser per scrivere ed eseguire codice Python. Per utilizzare Google Colab, è necessario un account Google. Utilizza Google Colab per creare un Jupyter Notebook in 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)
 

Dopo aver effettuato la chiamata ` API `, potresti ricevere una risposta ` JSON ` simile a quella mostrata nel seguente blocco di codice:

  {
    "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
    }
}