Tutoriel : Obtenir le taux d'erreur d'un service

Une requête de type « curl » adressée à ce point de terminaison ne nécessite ni paramètres de requête ni données de requête.

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

La réponse est un catalogue de métriques, c'est-à-dire une liste des types de métriques pris en charge. Vous pouvez faire défiler la liste pour trouver les metricId et aggregation correspondant aux données métriques que vous souhaitez extraire pour un service.

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

Prenez l'un des types de métriques suivants issus du catalogue présenté dans la section précédente. Deux informations que vous devez extraire de l'entrée du catalogue des métriques :

• metricId - un identifiant unique pour le type de métrique
• aggregation - agrégations statistiques disponibles pour la mesure. Un type de métrique peut avoir une ou plusieurs agrégations.

Pour le type de métrique « taux d'erreur » souhaité, vous pouvez constater qu'il n'y a qu'une seule agrégation disponible : « MOYENNE ».

Vous pouvez tester ce point de terminaison depuis la ligne de commande. Vous pouvez rapidement vérifier si vous disposez des informations nécessaires pour effectuer la requête REST HTTP et si vous disposez des autorisations d'accès requises. Il vous fournit également le contenu de la réponse, que vous pouvez examiner.

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

Pour automatiser par programmation la récupération d'une liste de services pour une application spécifique, vous pouvez essayer la fonction Python suivante, qui utilise la requests bibliothèque pour récupérer tous les services d'une application donnée via le point de terminaison GET des métriques de service.

Si vous ne disposez pas d'un environnement Python sur votre ordinateur local, vous pouvez tester cette fonction en utilisant un Jupyter Notebook dans Google Colab, qui fournit un environnement dans le navigateur permettant d'écrire et d'exécuter du code Python. Pour utiliser Google Colab, vous devez disposer d'un compte Google. Utilisez Google Colab pour créer un Jupyter Notebook dans 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)
 

Une fois que vous avez effectué l'appel ` API `, vous pourriez recevoir une réponse ` JSON ` similaire à celle présentée dans le bloc de code suivant :

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