add-telemetry parancs

OpenTelemetria- és Azure Application Insights-beállítások hozzáadása vagy frissítése egy meglévő Data API Builder-konfigurációs fájlban. Ha a runtime.telemetry szakasz nem létezik, létrejön. A meg nem határozott beállítások változatlanul hagyják a meglévő értékeket.

Megjegyzés:

A telemetriai beállítások nem konfigurálhatók a dab configure. Minden módosításhoz runtime.telemetry használhatódab add-telemetry.

Fogalmi útmutatásért és a végpontok közötti útmutatókért lásd: OpenTelemetry és tevékenységkövetések használata, valamint az Azure Application Insights használata.

Szemantika

dab add-telemetry [options]

Gyors áttekintés

Lehetőség Összefoglalás
-c, --config Konfigurációs fájl elérési útja. Alapértelmezett dab-config.json.

OpenTelemetry szakasz

Lehetőség Összefoglalás
--otel-enabled OpenTelemetria engedélyezése vagy letiltása.
--otel-endpoint OpenTelemetry Collector végpont URL-címe.
--otel-protocol Exportálási protokoll. Engedélyezett értékek: grpc, httpprotobuf.
--otel-service-name Szolgáltatásnévcímke az összes telemetrián.
--otel-headers Az OpenTelemetry-gyűjtőnek küldendő további fejlécek.

Azure Application Insights szakasz

Lehetőség Összefoglalás
--app-insights-enabled Az Azure Application Insights engedélyezése vagy letiltása.
--app-insights-conn-string Application Insights kapcsolati karaktersor.

-c, --config

A konfigurációs fájl elérési útja. Alapértelmezett érték, dab-config.json ha dab-config.<DAB_ENVIRONMENT>.json nem létezik, ahol DAB_ENVIRONMENT környezeti változó van.

Example

dab add-telemetry \
  --config ./my-config.json \
  --otel-enabled true

--otel-enabled

Engedélyezze vagy tiltsa le az OpenTelemetry-exportőrt. Elfogadott értékek: true, false.

Example

dab add-telemetry \
  --otel-enabled true

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true
      }
    }
  }
}

--otel-endpoint

Az OpenTelemetry-gyűjtő vagy a háttér url-címe. A gRPC-hez használja a következőt http://<host>:<port>: . HTTP esetén adja meg például http://<host>:<port>/v1/tracesa teljes elérési utat.

Example

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4317"

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4317"
      }
    }
  }
}

--otel-protocol

Az OpenTelemetry-exportőr exportálási protokollja. Engedélyezett értékek: grpc, httpprotobuf. Alapértelmezett érték: grpc.

Example

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4318" \
  --otel-protocol "httpprotobuf"

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4318",
        "exporter-protocol": "httpprotobuf"
      }
    }
  }
}

--otel-service-name

Az összes nyomkövetéshez és metrikához csatolt szolgáltatásnévcímke. Szolgáltatásazonosítóként jelenik meg a telemetriai háttérrendszerben. Alapértelmezett érték: dab.

Example

dab add-telemetry \
  --otel-enabled true \
  --otel-service-name "my-dab-api"

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "service-name": "my-dab-api"
      }
    }
  }
}

--otel-headers

További HTTP-fejlécek a telemetriai adatok gyűjtőbe való exportálásakor. Használjon vesszővel tagolt key=value listát. Ezt a lehetőséget olyan hitelesített gyűjtővégpontokhoz használhatja, amelyekhez API-kulcs vagy engedélyezési fejléc szükséges.

Example

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "https://collector.example.com:4317" \
  --otel-headers "api-key=my-secret-key"

--app-insights-enabled

Az Azure Application Insights telemetriájának engedélyezése vagy letiltása. Elfogadott értékek: true, false.

Example

dab add-telemetry \
  --app-insights-enabled true

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true
      }
    }
  }
}

--app-insights-conn-string

Kapcsolati sztring az Azure Application Insights-erőforráshoz. Használjon környezeti változóhivatkozást, hogy elkerülje a titkos kulcsok forráskontrollhoz való véglegesítését.

Figyelmeztetés

Soha ne kódozza a kapcsolati sztringet közvetlenül a konfigurációs fájlban. Használjon @env('<variable-name>') vagy titkos kulcskezelőt.

Example

dab add-telemetry \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('APP_INSIGHTS_CONN_STRING')"

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('APP_INSIGHTS_CONN_STRING')"
      }
    }
  }
}

Teljes példa: OpenTelemetry és Application Insights

Az alábbi példa egyetlen parancsban teszi lehetővé az OpenTelemetry és az Application Insights szolgáltatást is.

dab add-telemetry \
  --otel-enabled true \
  --otel-endpoint "http://localhost:4317" \
  --otel-protocol "grpc" \
  --otel-service-name "my-dab-api" \
  --app-insights-enabled true \
  --app-insights-conn-string "@env('APP_INSIGHTS_CONN_STRING')"

Eredményként kapott konfiguráció

{
  "runtime": {
    "telemetry": {
      "open-telemetry": {
        "enabled": true,
        "endpoint": "http://localhost:4317",
        "service-name": "my-dab-api",
        "exporter-protocol": "grpc"
      },
      "application-insights": {
        "enabled": true,
        "connection-string": "@env('APP_INSIGHTS_CONN_STRING')"
      }
    }
  }
}

Kapcsolódó tartalom

  • Last updated on