Helyi metrikák és naplók konfigurálása az Azure API Management saját üzemeltetésű átjáróhoz

A KÖVETKEZŐKRE VONATKOZIK: Fejlesztő | Prémium

Ez a cikk az önállóan üzemeltetett átjáró Kubernetes-fürtön történő üzembe helyezéséhez szükséges helyi metrikák és naplók konfigurálásának részleteit ismerteti. A felhőmetrikák és naplók konfigurálásáról ebben a cikkben olvashat.

Mértékek

A saját üzemeltetésű átjáró támogatja a StatsD-t, amely a metrikák gyűjtésének és összesítésének egységesítő protokollja. Ez a szakasz végigvezeti a StatsD Kubernetesben való üzembe helyezésének lépésein, konfigurálja az átjárót metrikák StatsD-n keresztüli kibocsátásához, valamint a Prometheus használatával a metrikák monitorozásához.

A StatsD és a Prometheus üzembe helyezése a fürtön

Az alábbi YAML-mintakonfiguráció üzembe helyezi a StatsD-t és a Prometheust a Kubernetes-fürtön, ahol egy saját üzemeltetésű átjáró van üzembe helyezve. Emellett létrehoz egy szolgáltatást is mindegyikhez. A saját üzemeltetésű átjáró ezután közzéteszi a metrikákat a StatsD szolgáltatásban. A Prometheus-irányítópultot a szolgáltatáson keresztül érheti el.

Megjegyzés:

Az alábbi példa nyilvános tárolórendszerképeket kér le a Docker Hubról. Állítson be egy lekéréshez szükséges titkos kulcsot Docker Hub-fiók használatával történő hitelesítéshez a névtelen lekérések helyett. A nyilvános tartalommal végzett munka megbízhatóságának javítása érdekében importálja és kezelje a rendszerképeket egy privát Azure Container Registryben. Tudjon meg többet a nyilvános képekkel való munkáról.

apiVersion: v1
kind: ConfigMap
metadata:
  name: sputnik-metrics-config
data:
  statsd.yaml: ""
  prometheus.yaml: |
    global:
      scrape_interval:     3s
      evaluation_interval: 3s
    scrape_configs:
      - job_name: 'prometheus'
        static_configs:
          - targets: ['localhost:9090']
      - job_name: 'test_metrics'
        static_configs:
          - targets: ['localhost:9102']
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: sputnik-metrics
spec:
  replicas: 1
  selector:
    matchLabels:
      app: sputnik-metrics
  template:
    metadata:
      labels:
        app: sputnik-metrics
    spec:
      containers:
      - name: sputnik-metrics-statsd
        image: prom/statsd-exporter
        ports:
        - name: tcp
          containerPort: 9102
        - name: udp
          containerPort: 8125
          protocol: UDP
        args:
          - --statsd.mapping-config=/tmp/statsd.yaml
          - --statsd.listen-udp=:8125
          - --web.listen-address=:9102
        volumeMounts:
          - mountPath: /tmp
            name: sputnik-metrics-config-files
      - name: sputnik-metrics-prometheus
        image: prom/prometheus
        ports:
        - name: tcp
          containerPort: 9090
        args:
          - --config.file=/tmp/prometheus.yaml
        volumeMounts:
          - mountPath: /tmp
            name: sputnik-metrics-config-files
      volumes:
        - name: sputnik-metrics-config-files
          configMap:
            name: sputnik-metrics-config
---
apiVersion: v1
kind: Service
metadata:
  name: sputnik-metrics-statsd
spec:
  type: NodePort
  ports:
  - name: udp
    port: 8125
    targetPort: 8125
    protocol: UDP
  selector:
    app: sputnik-metrics
---
apiVersion: v1
kind: Service
metadata:
  name: sputnik-metrics-prometheus
spec:
  type: LoadBalancer
  ports:
  - name: http
    port: 9090
    targetPort: 9090
  selector:
    app: sputnik-metrics

Mentse a konfigurációkat egy nevű metrics.yamlfájlba. A következő paranccsal mindent üzembe helyezhet a fürtön:

kubectl apply -f metrics.yaml

Az üzembe helyezés befejeződése után futtassa a következő parancsot a podok futásának ellenőrzéséhez. A pod neve különbözik.

kubectl get pods
NAME                                   READY   STATUS    RESTARTS   AGE
sputnik-metrics-f6d97548f-4xnb7        2/2     Running   0          1m

Futtassa a következő parancsot annak ellenőrzésére, hogy a services futnak-e. Jegyezze fel a CLUSTER-IP és a PORT adatait a StatsD szolgáltatásból, amelyeket később használni fog. A Prometheus irányítópultját a saját EXTERNAL-IP és PORT segítségével látogathatja meg.

kubectl get services
NAME                         TYPE           CLUSTER-IP    EXTERNAL-IP     PORT(S)                      AGE
sputnik-metrics-prometheus   LoadBalancer   10.0.252.72   13.89.141.90    9090:32663/TCP               18h
sputnik-metrics-statsd       NodePort       10.0.41.179   <none>          8125:32733/UDP               18h

A saját üzemeltetésű átjáró konfigurálása metrikák kibocsátásához

Most, hogy a StatsD és a Prometheus is üzembe lett helyezve, frissítheti a saját üzemeltetésű átjáró konfigurációit a metrikák StatsD-n keresztüli kibocsátásának megkezdéséhez. A funkció engedélyezéséhez vagy letiltásához használja a telemetry.metrics.local saját üzemeltetésű átjáró üzembe helyezésének konfigurációtérképén található kulcsot. További beállításokat is megadhat. A következő lehetőségek érhetők el:

szakterület	Alapértelmezett	Leírás
telemetry.metrics.local	`none`	Engedélyezi a naplózást a StatsD-ben. Az érték lehet `none`, `statsd`.
telemetry.metrics.local.statsd.endpoint	nincs adat	StatsD-végpontot ad meg.
telemetry.metrics.local.statsd.mintavétel	nincs adat	A metrikák mintavételezési sebességét határozza meg. Az érték 0 és 1 között lehet. Példa: `0.5`
telemetry.metrikák.helyi.statsd.címke-formátum	nincs adat	StatsD exportőr címkézési formátuma. Az érték lehet `none`, `librato`, `dogStatsD`. `influxDB`

Íme egy mintakonfiguráció:

apiVersion: v1
kind: ConfigMap
metadata:
    name: contoso-gateway-environment
data:
    config.service.endpoint: "<self-hosted-gateway-management-endpoint>"
    telemetry.metrics.local: "statsd"
    telemetry.metrics.local.statsd.endpoint: "10.0.41.179:8125"
    telemetry.metrics.local.statsd.sampling: "1"
    telemetry.metrics.local.statsd.tag-format: "dogStatsD"

Frissítse a saját üzemeltetésű átjáró üzembe helyezésének YAML-fájlját az előző konfigurációkkal, és alkalmazza a módosításokat a következő paranccsal:

kubectl apply -f <file-name>.yaml

A legújabb konfigurációs módosítások felvételéhez indítsa újra az átjáró üzembe helyezését a következő paranccsal:

kubectl rollout restart deployment/<deployment-name>

A metrikák megtekintése

Most, hogy mindent üzembe helyezett és konfigurált, a saját üzemeltetésű átjáró a metrikákat a StatsD-n keresztül jelenti. A Prometheus ezután felveszi a metrikákat a StatsD-ből. Nyissa meg a Prometheus vezérlőpultot a Prometheus szolgáltatás EXTERNAL-IP és PORT használatával.

Hozzon létre néhány API-hívást a saját üzemeltetésű átjárón keresztül. Ha minden megfelelően van konfigurálva, a következő metrikákat tekintheti meg:

Mértékegység	Leírás
kérések_összesen	AZ IDŐSZAK API-kéréseinek száma
kérés_időtartam_másodpercek	A kérelem átjáróhoz való megérkezése és a teljes válasz elküldése között eltelt ezredmásodpercek száma
kérés_háttérrendszer_időtartam_másodpercben	A háttérrendszer teljes I/O-jára fordított ezredmásodpercek száma (bájtok csatlakoztatása, küldése és fogadása)
ügyfél-kérés időtartam másodpercben	Az ügyfél teljes I/O-jára fordított ezredmásodpercek száma (bájtok csatlakoztatása, küldése és fogadása)

Naplók

Alapértelmezés szerint a saját üzemeltetésű átjáró stdout és stderr naplókat ad ki. A naplók egyszerűen megtekinthetők az alábbi paranccsal:

kubectl logs <pod-name>

Ha a saját üzemeltetésű átjárót az Azure Kubernetes Service-ben helyezi üzembe, engedélyezheti az Azure Monitor for containers használatát, hogy gyűjtsön adatokat a feladatokból, és tekintse meg a naplókat a Log Analyticsben.

A saját üzemeltetésű átjáró számos protokollt támogat, többek között localsyslog, rfc5424 és journal. Az alábbi táblázat összefoglalja az összes támogatott beállítást.

szakterület	Alapértelmezett	Leírás
telemetry.logs.std	`text`	Engedélyezi a naplózást a szokványos adatfolyamokra. Az érték lehet `none`, , `textjson`
telemetry.logs.local	`auto`	Engedélyezi a helyi naplózást. Az érték lehet `none`, `auto`, `localsyslog`, `rfc5424`, , `journaljson`
telemetry.logs.local.localsyslog.endpoint	nincs adat	A helyi syslog-végpontot adja meg. További részletekért lásd a helyi syslog-naplók használatát.
telemetry.logs.local.localsyslog.facility	nincs adat	Megadja a helyi syslog-létesítmény kódját. Példa: `7`
telemetry.logs.local.rfc5424.endpoint	nincs adat	Az rfc5424 végpontot adja meg.
telemetry.logs.local.rfc5424.facility	nincs adat	Az rfc5424 létesítménykódját adja meg. Példa: `7`
telemetry.naplók.helyi.napló.végpont	nincs adat	Naplóvégpontot ad meg.
.endpoint telemetry.logs.local.json	127.0.0.1:8888	Adja meg a JSON-adatokat fogadó UDP-végpontot: fájl elérési út, IP:port vagy gazdagépnév:port.

Íme egy mintakonfiguráció a helyi naplózáshoz:

    apiVersion: v1
    kind: ConfigMap
    metadata:
        name: contoso-gateway-environment
    data:
        config.service.endpoint: "<self-hosted-gateway-management-endpoint>"
        telemetry.logs.std: "text"
        telemetry.logs.local.localsyslog.endpoint: "/dev/log"
        telemetry.logs.local.localsyslog.facility: "7"

Helyi JSON-végpont használata

Ismert korlátozások

A helyi diagnosztikai funkció legfeljebb 3072 bájtnyi kérelem- és válasz-hasznos adatot támogat. Ha a hasznos adat mérete meghaladja ezt a korlátot, előfordulhat, hogy az adattömbelés megszakítja a JSON formátumot.

Helyi syslog-naplók használata

Átjáró konfigurálása naplók streameléséhez

Ha helyi syslogot használ a naplók célhelyeként, a futtatókörnyezetnek engedélyeznie kell a streamnaplók célhelyre való átvitelét. Az Azure Kubernetes Service esetén csatlakoztatnia kell egy, a célnak megfelelő kötetet.

A következő konfigurációt figyelembe véve:

apiVersion: v1
kind: ConfigMap
metadata:
    name: contoso-gateway-environment
data:
    config.service.endpoint: "<self-hosted-gateway-management-endpoint>"
    telemetry.logs.local: localsyslog
    telemetry.logs.local.localsyslog.endpoint: /dev/log

A streamelési naplókat egyszerűen elindíthatja a helyi syslog-végponton:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: contoso-deployment
  labels:
    app: contoso
spec:
  replicas: 1
  selector:
    matchLabels:
      app: contoso
  template:
    metadata:
      labels:
        app: contoso
    spec:
      containers:
        name: azure-api-management-gateway
        image: mcr.microsoft.com/azure-api-management/gateway:2.5.0
        imagePullPolicy: IfNotPresent
        envFrom:
        - configMapRef:
            name: contoso-gateway-environment
        # ... redacted ...
+       volumeMounts:
+       - mountPath: /dev/log
+         name: logs
+     volumes:
+     - hostPath:
+         path: /dev/log
+         type: Socket
+       name: logs

Helyi syslog-naplók felhasználása az Azure Kubernetes Service (AKS) szolgáltatásban

Ha helyi syslogot konfigurál az Azure Kubernetes Service-ben, kétféleképpen vizsgálhatja meg a naplókat:

A Syslog-gyűjtemény használata a Container Insights használatával
A munkavégző csomópontok naplóinak elérése és vizsgálata

Naplók felhasználása feldolgozó csomópontokból

A naplókat egyszerűen felhasználhatja a feldolgozó csomópontokhoz való hozzáféréssel:

Hozzon létre egy SSH-kapcsolatot a csomóponttal (docs).
Találja meg a naplókat itt: host/var/log/syslog.

Szűrheti például az összes syslogot csak a saját üzemeltetésű átjáróból származókra:

$ cat host/var/log/syslog | grep "apimuser"
May 15 05:54:20 aks-agentpool-43853532-vmss000000 apimuser[8]: Timestamp=2023-05-15T05:54:20.0445178Z, isRequestSuccess=True, totalTime=290, category=GatewayLogs, callerIpAddress=141.134.132.243, timeGenerated=2023-05-15T05:54:20.0445178Z, region=Repro, correlationId=aaaa0000-bb11-2222-33cc-444444dddddd, method=GET, url="http://20.126.242.200/echo/resource?param1\=sample", backendResponseCode=200, responseCode=200, responseSize=628, cache=none, backendTime=287, apiId=echo-api, operationId=retrieve-resource, apimSubscriptionId=master, clientProtocol=HTTP/1.1, backendProtocol=HTTP/1.1, apiRevision=1, backendMethod=GET, backendUrl="http://echoapi.cloudapp.net/api/resource?param1\=sample"
May 15 05:54:21 aks-agentpool-43853532-vmss000000 apimuser[8]: Timestamp=2023-05-15T05:54:21.1189171Z, isRequestSuccess=True, totalTime=150, category=GatewayLogs, callerIpAddress=141.134.132.243, timeGenerated=2023-05-15T05:54:21.1189171Z, region=Repro, correlationId=bbbb1111-cc22-3333-44dd-555555eeeeee, method=GET, url="http://20.126.242.200/echo/resource?param1\=sample", backendResponseCode=200, responseCode=200, responseSize=628, cache=none, backendTime=148, apiId=echo-api, operationId=retrieve-resource, apimSubscriptionId=master, clientProtocol=HTTP/1.1, backendProtocol=HTTP/1.1, apiRevision=1, backendMethod=GET, backendUrl="http://echoapi.cloudapp.net/api/resource?param1\=sample"

Megjegyzés:

Ha a gyökeret chroot például chroot /host módosítja, akkor az előző elérési útnak tükröznie kell ezt a változást.

Ismerje meg az Azure API Management-átjárók megfigyelhetőségi képességeit.
További információ az Azure API Management saját üzemeltetésű átjárójáról.
Tudnivalók a naplók felhőben való konfigurálásáról és megőrzéséről.

Visszajelzés

Hasznosnak találta ezt az oldalt?

Last updated on 2025-10-13