チュートリアルサービスのエラー率を取得する

このエンドポイントへのcurlリクエストは、クエリパラメータとリクエストペイロードを必要としない。

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

レスポンスはメトリック・カタログであり、これはサポートされているメトリックタイプのリストである。 これをスクロールして、サービスのために引き出したいメトリック・データの metricId と aggregation を見つけることができる。

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

前のセクションに戻ったカタログから、次のメトリックタイプの一つを考えてみよう。 メトリックス・カタログ・エントリから取得しなければならない 2 つの情報：

• metricId - メトリックの種類を示す一意の識別子
• aggregation - メトリックの利用可能な統計的集計。 メトリックタイプは1つ以上の集約を持つことができる。

希望する「エラー率」の指標タイプでは、利用可能な集計は1つだけであることがわかる--「MEAN」である。

このエンドポイントはコマンドラインからテストできる。 HTTP RESTリクエストを行うための正しい情報と、適切なアクセス権限があるかどうかをすぐに判断できます。 また、レスポンスのペイロードも提供されるので、それを調査することもできる。

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

特定のアプリケーションのサービス一覧をプログラムで自動取得するには、 requests ライブラリを使用して、 GET サービス・メトリック・エンドポイントを使用する指定されたアプリケーションのすべてのサービスを取得する、次の Python 関数を試すことができます。

ローカルマシンに Python 環境がセットアップされていない場合は、 Google Colabの Jupyter Notebook、ブラウザで Python コードを書いて実行する環境を提供することで、この機能を試すことができる。 Google Colabをご利用いただくには、 Google アカウントが必要です。 Google Colabを使って Colabで Jupyter Notebook。

# 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)

APIコールを行った後、以下のコードブロックに示すようなJSONレスポンスを受け取るかもしれない：

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