Simple Log Service:API HTTP de MetricStore

API d'interrogation instantanée

L'API d'interrogation instantanée permet de récupérer les données de métriques à un instant précis.

GET https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query
POST https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query

Paramètres :

Cette API renvoie les quatre types de résultats suivants :

• vector

  • Exemple de code

    curl -X GET 'http://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query?query=up&time=1676700699' \
    -u username:password \
    -H 'Content-Type: application/x-www-form-urlencoded'
    
    # Set username to your AccessKey ID and password to your AccessKey Secret.

  • Résultat

    {
        "status": "success",
        "data": {
            "resultType": "vector",
            "result": [
                {
                    "metric": {
                        "__name__": "up",
                        "instance": "demo.promlabs.com:10001",
                        "job": "demo"
                    },
                    "value": [
                        1676700550.696,
                        "1"
                    ]
                },
                {
                    "metric": {
                        "__name__": "up",
                        "instance": "demo.promlabs.com:10000",
                        "job": "demo"
                    },
                    "value": [
                        1676700550.696,
                        "1"
                    ]
                }
            ]
        }
    }

• scalar

  • Exemple de code

    curl -X GET 'http://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query?query=2-1&time=1676700699' \
    -u username:password \
    -H 'Content-Type: application/x-www-form-urlencoded'
    
    # Set username to your AccessKey ID and password to your AccessKey Secret.

  • Résultat

    {
        "status": "success",
        "data": {
            "resultType": "scalar",
            "result": [
                1676700699,
                "0"
            ]
        }
    }

• string

  • Exemple de code

    curl -X GET 'http://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query?query="test_string"&time=1676700699' \
    -u username:password \
    -H 'Content-Type: application/x-www-form-urlencoded'
    
    # Set username to your AccessKey ID and password to your AccessKey Secret.

  • Résultat

    {
        "status": "success",
        "data": {
            "resultType": "string",
            "result": [
                1676700699,
                "test_string"
            ]
        }
    }

• matrix

  • Exemple de code

    curl -X GET 'http://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query?query=up[1m]&time=1743414624' \
    -u username:password \
    -H 'Content-Type: application/x-www-form-urlencoded'
    
    # Set username to your AccessKey ID and password to your AccessKey Secret.

  • Résultat

    {
        "status": "success",
        "data": {
            "resultType": "matrix",
            "result": [
                {
                    "metric": {
                        "__name__": "up",
                        "instance": "demo.promlabs.com:10000",
                        "job": "demo"
                    },
                    "values": [
                        [
                            1743414609.803,
                            "1"
                        ],
                        [
                            1743414614.803,
                            "1"
                        ],
                        [
                            1743414619.803,
                            "1"
                        ]
                    ]
                },
                {
                    "metric": {
                        "__name__": "up",
                        "instance": "demo.promlabs.com:10001",
                        "job": "demo"
                    },
                    "values": [
                        [
                            1743414611.078,
                            "1"
                        ],
                        [
                            1743414616.078,
                            "1"
                        ],
                        [
                            1743414621.078,
                            "1"
                        ]
                    ]
                }
            ]
        }
    }

API d'interrogation par plage

L'API d'interrogation par plage permet de récupérer les données de métriques à plusieurs instants au sein d'une plage temporelle donnée.

GET https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query_range
POST https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query_range

Paramètres :

• Exemple de code

  Interrogez les données de métriques du 18 février 2023 à 14:09:59 jusqu'au 18 février 2023 à 14:16:39, avec un step de 60 s.

  curl -X GET 'https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/query_range?query=up&start=1676700599&end=1676700999&step=60s' \
  -u username:password \
  -H 'Content-Type: application/x-www-form-urlencoded'
  
  # Set username to your AccessKey ID and password to your AccessKey Secret.

• Résultat

  {
    "status": "success",
    "data": {
      "resultType": "matrix",
      "result": [
        {
          "metric": {
            "__name__": "up",
            "instance": "demo.promlabs.com:10000",
            "job": "demo"
          },
          "values": [
            [
              1676700599,
              "1"
            ],
            [
              1676700659,
              "1"
            ],
            [
              1676700719,
              "0"
            ],
            [
              1676700779,
              "0"
            ],
            [
              1676700839,
              "1"
            ],
            [
              1676700899,
              "0"
            ],
            [
              1676700959,
              "1"
            ]
          ]
        },
        {
          "metric": {
            "__name__": "up",
            "instance": "demo.promlabs.com:10001",
            "job": "demo"
          },
          "values": [
            [
              1676700599,
              "1"
            ],
            [
              1676700659,
              "1"
            ],
            [
              1676700719,
              "0"
            ],
            [
              1676700779,
              "0"
            ],
            [
              1676700839,
              "1"
            ],
            [
              1676700899,
              "1"
            ],
            [
              1676700959,
              "1"
            ]
          ]
        }
      ]
    }
  }

API d'interrogation des séries

L'API d'interrogation des séries récupère tous les noms de métriques ainsi que leurs paires clé-valeur de libellés correspondant à des sélecteurs spécifiques sur une plage temporelle donnée.

GET https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/series
POST https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/series

Paramètres :

• Exemple de requête

  curl -g -X GET 'https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/series?match[]=up{instance="demo.promlabs.com:10000"}&match[]=go_sched_latencies_seconds_bucket&start=1676700599&end=1676700999' \
  -u username:password \
  -H 'Content-Type: application/x-www-form-urlencoded'
  
  # Set username to your AccessKey ID and password to your AccessKey Secret.

• Résultat

  {
      "status": "success",
      "data": [
          {
              "__name__": "go_gc_duration_seconds_count",
              "instance": "demo.promlabs.com:10000",
              "job": "demo"
          },
          {
              "__name__": "go_gc_duration_seconds_count",
              "instance": "demo.promlabs.com:10001",
              "job": "demo"
          },
          {
              "__name__": "up",
              "instance": "demo.promlabs.com:10000",
              "job": "demo"
          }
      ]
  }

API d'interrogation des noms de libellés

L'API d'interrogation des noms de libellés récupère tous les noms de libellés issus des séries correspondant aux sélecteurs spécifiés sur une plage temporelle donnée.

GET https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/labels
POST https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/labels

Paramètres :

• Exemple de requête

  Récupérez tous les noms de libellés pour toutes les métriques sur la plage temporelle spécifiée.

  curl -X GET 'https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/labels?start=1676700599&end=1676700999' \
  -u username:password \
  -H 'Content-Type: application/x-www-form-urlencoded'
  
  # Set username to your AccessKey ID and password to your AccessKey Secret.

• Résultat

  {
      "status": "success",
      "data": [
          "code",
          "instance",
          "job",
          "le",
          "method",
          "mode",
          "path",
          "quantile",
          "status",
          "type",
          "version",
          "__name__"
      ]
  }

API d'interrogation des valeurs de libellés

L'API d'interrogation des valeurs de libellés récupère toutes les valeurs associées à un nom de libellé spécifique, issues des séries correspondant aux sélecteurs spécifiés sur une plage temporelle donnée.

GET https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/label/<label_name>/values

Paramètres :

• Exemple de requête

  Récupérez toutes les valeurs du libellé instance pour la métrique up sur la plage temporelle spécifiée.

  curl -X GET 'https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}/api/v1/label/instance/values?match[]=up&start=1676700599&end=1676700999' \
  -u username:password \
  -H 'Content-Type: application/x-www-form-urlencoded'
  
  # Set username to your AccessKey ID and password to your AccessKey Secret.

• Résultat

  {
      "status": "success",
      "data": [
          "demo.promlabs.com:10000",
          "demo.promlabs.com:10001",
          "demo.promlabs.com:10002"
      ]
  }

HTTP

import (
	"flag"
	"fmt"
	"io/ioutil"
	"net/http"
	"net/url"
	"strconv"
	"strings"
	"time"
)

const separator = "#"

func http_main() {

	project := flag.String("project", "xxxx", "")
	metricStore := flag.String("metricstore", "xxxx", "")
	endpoint := flag.String("endpoint", "xxxx", "")
	akId := flag.String("akid", "xxxx", "")
	akKey := flag.String("aksecret", "xxxx", "")
	query := flag.String("query", "avg(up)", "")
	queryType := flag.String("type", "values", "range or query or labels or values or series")
	matches := flag.String("match", "up", "") // Use a number sign (#) to separate multiple match[] parameters.
	labelName := flag.String("label", "instance", "")
	step := flag.String("step", "1m", "")
	fromtime := flag.String("from", "2023-02-15T00:00:00Z", "time 2006-01-02T15:04:05Z07:00")
	totime := flag.String("to", "2023-02-15T00:15:00Z", "time 2006-01-02T15:04:05Z07:00")

	flag.Parse()

	timeFrom, err := time.Parse(time.RFC3339, *fromtime)
	if err != nil {
		panic(err)
	}
	timeTo, err := time.Parse(time.RFC3339, *totime)
	if err != nil {
		panic(err)
	}

	// URL: https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}
	prometheusEndpoint := fmt.Sprintf("https://%s/prometheus/%s/%s", *project+"."+*endpoint, *project, *metricStore)

	var uri string
	urlVal := url.Values{}
	urlVal.Add("start", strconv.FormatInt(timeFrom.Unix(), 10))
	urlVal.Add("end", strconv.FormatInt(timeTo.Unix(), 10))

	switch *queryType {
	case "range":
		urlVal.Add("query", *query)
		urlVal.Add("step", *step)
		uri = fmt.Sprintf("%s/api/v1/query_range?%v", prometheusEndpoint, urlVal.Encode())
	case "query":
		urlVal.Add("query", *query)
		urlVal.Add("time", strconv.FormatInt(timeTo.Unix(), 10))
		uri = fmt.Sprintf("%s/api/v1/query?%v", prometheusEndpoint, urlVal.Encode())
	case "labels":
		extractAddMatches(*matches, urlVal)
		uri = fmt.Sprintf("%s/api/v1/labels?%v", prometheusEndpoint, urlVal.Encode())
	case "values":
		extractAddMatches(*matches, urlVal)
		uri = fmt.Sprintf("%s/api/v1/label/%s/values?%v", prometheusEndpoint, *labelName, urlVal.Encode())
	case "series":
		extractAddMatches(*matches, urlVal)
		uri = fmt.Sprintf("%s/api/v1/series?%v", prometheusEndpoint, urlVal.Encode())
	}

	req, _ := http.NewRequest(http.MethodGet, uri, nil)
	req.SetBasicAuth(*akId, *akKey)

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	buf, err := ioutil.ReadAll(resp.Body)
	resp.Body.Close()
	if err != nil {
		panic(err)
	}

	fmt.Println(string(buf))

}

func extractAddMatches(matches string, uVal url.Values) {
	splits := strings.Split(matches, separator)
	for _, match := range splits {
		uVal.Add("match[]", match)
	}
}

SDK Prometheus

L'exemple suivant utilise la bibliothèque Prometheus client_golang v1.14.0.

import (
	"context"
	"flag"
	"fmt"
	"github.com/prometheus/client_golang/api"
	v1 "github.com/prometheus/client_golang/api/prometheus/v1"
	"net"
	"net/http"
	"net/url"
	"time"
)

func main() {
	project := flag.String("project", "xxxx", "")
	metricStore := flag.String("metricstore", "xxxx", "")
	endpoint := flag.String("endpoint", "xxxx", "")
	akId := flag.String("akid", "xxxx", "")
	akKey := flag.String("aksecret", "xxxx", "")
	flag.Parse()

	// URL: https://{project}.{sls-endpoint}/prometheus/{project}/{metricstore}
	prometheusEndpoint := fmt.Sprintf("https://%s.%s/prometheus/%s/%s", *project, *endpoint, *project, *metricStore)

	client, err := api.NewClient(api.Config{
		Address: prometheusEndpoint,
		RoundTripper: &http.Transport{
			// Set Basic Auth
			Proxy: func(req *http.Request) (*url.URL, error) {
				req.SetBasicAuth(*akId, *akKey)
				return nil, nil
			},
			DialContext: (&net.Dialer{
				Timeout:   60 * time.Second,
				KeepAlive: 60 * time.Second,
			}).DialContext,
			TLSHandshakeTimeout: 10 * time.Second,
		},
	})
	if err != nil {
		panic(err)
	}

	v1api := v1.NewAPI(client)
	ctx, _ := context.WithTimeout(context.Background(), 60*time.Second)
	r := v1.Range{
		Start: time.Now().Add(-15 * time.Minute),
		End:   time.Now(),
		Step:  time.Minute,
	}
	// query range
	result, warnings, err := v1api.QueryRange(ctx, "avg(up)", r)
	if err != nil {
		panic(err)
	}
	if len(warnings) > 0 {
		fmt.Printf("Warnings: %v %v\n", warnings, result)
	}
	fmt.Println(result)

	// query
	result, warnings, err = v1api.Query(ctx, "avg(up)", time.Now())
	if err != nil {
		panic(err)
	}
	if len(warnings) > 0 {
		fmt.Printf("Warnings: %v %v\n", warnings, result)
	}
	fmt.Println(result)

	// series
	series, warnings, err := v1api.Series(ctx, []string{"up"}, time.Now().Add(-15*time.Minute), time.Now())
	if err != nil {
		panic(err)
	}
	if len(warnings) > 0 {
		fmt.Printf("Warnings: %v %v\n", warnings, result)
	}
	fmt.Println(series)

	// labels
	names, warnings, err := v1api.LabelNames(ctx, []string{"up"}, time.Now().Add(-15*time.Minute), time.Now())
	if err != nil {
		panic(err)
	}
	if len(warnings) > 0 {
		fmt.Printf("Warnings: %v %v\n", warnings, result)
	}
	fmt.Println(names)

	// labelValues
	values, warnings, err := v1api.LabelValues(ctx, "instance", []string{"up"}, time.Now().Add(-15*time.Minute), time.Now())
	if err != nil {
		panic(err)
	}
	if len(warnings) > 0 {
		fmt.Printf("Warnings: %v %v\n", warnings, result)
	}
	fmt.Println(values)
}

Échec d'authentification

• La réponse suivante indique un échec d'authentification. Vérifiez que vos identifiants AccessKey sont corrects.

  {
      "status": "error",
      "code": "401",
      "errorType": "unauthorized",
      "error": "get query instance error: {\n    \"httpCode\": 401,\n    \"errorCode\": \"Unauthorized\",\n    \"errorMessage\": \"AccessKeyId not found: xxxx\",\n    \"requestID\": \"xxxx\"\n}"
  }

• Cette erreur peut également survenir si l'adresse IP source ne figure pas dans la liste blanche des blocs CIDR VPC. Ajoutez l'adresse IP à la liste blanche des blocs CIDR VPC.

  {
      "status": "error",
      "code": "401",
      "errorType": "unauthorized",
      "error": "get query instance error: {\n    \"httpCode\": 401,\n    \"errorCode\": \"Unauthorized\",\n    \"errorMessage\": \"AccessKeyId not found: xxxx\",\n    \"requestID\": \"xxxx\"\n}"
  }

Erreur de syntaxe PromQL

La réponse suivante indique une expression PromQL invalide. Corrigez l'expression dans le paramètre query.

--> /api/v1/query_range?query=up[2m]&start=1676700599&end=1676700999&step=60s
{
    "status": "error",
    "errorType": "bad_data",
    "error": "invalid expression type \"range vector\" for range query, must be Scalar or instant Vector"
}

Erreur de délai d'expiration

La réponse suivante indique un dépassement du délai d'attente de la requête. Augmentez la valeur du paramètre timeout.

{
    "status": "error",
    "errorType": "timeout",
    "error": "query timed out in expression evaluation"
}

Requête incomplète

Une réponse accompagnée d'avertissements signale un résultat incomplet. Réduisez la plage temporelle et relancez la requête.

{
    "status": "success",
    "data": {
        "resultType": "matrix",
        "result": [
            {
                "metric": {},
                "values": [
                    [
                        1673798460,
                        "11111111"
                    ],
                    [
                        1673799060,
                        "22222222"
                    ],
                    [
                        1673799660,
                        "33333333"
                    ]
                ]
            }
        ]
    },
    "warnings": [
        "Request to Sls partial incompleted, incomplete task count : 11, total : 108"
    ]
}