add-telemetry komut

OpenTelemetry ve Azure Application Insights ayarlarını mevcut bir Data API builder yapılandırma dosyasına ekleyin veya güncelleştirin. runtime.telemetry Bölüm yoksa oluşturulur. Belirtilmeyen seçenekler var olan değerleri değiştirmeden bırakır.

Uyarı

Telemetri ayarları ile dab configureyapılandırılamaz. Tüm runtime.telemetry değişiklikler için kullanındab add-telemetry.

Kavramsal rehberlik ve uçtan uca kılavuzlar için bkz. OpenTelemetry ve etkinlik izlemelerini kullanma veAzure Application Insights'ı kullanma.

Sözdizimi

dab add-telemetry [options]

Hızlı bakış

Seçenek Özet
-c, --config Yapılandırma dosyası yolu. Varsayılan dab-config.json.

OpenTelemetry bölümü

Seçenek Özet
--otel-enabled OpenTelemetry'yi etkinleştirin veya devre dışı bırakın.
--otel-endpoint OpenTelemetry toplayıcı uç noktası URL'si.
--otel-protocol Dışarı aktarma protokolü. İzin verilen değerler: grpc, httpprotobuf.
--otel-service-name Tüm telemetride hizmet adı etiketi.
--otel-headers OpenTelemetry toplayıcısına gönderilecek ek üst bilgiler.

Azure Application Insights bölümü

Seçenek Özet
--app-insights-enabled Azure Application Insights'ı etkinleştirin veya devre dışı bırakın.
--app-insights-conn-string Application Insights bağlantı dizesi.

-c, --config

Yapılandırma dosyasının yolu. Varsayılan olarakdab-config.json, ortam değişkeni olduğu dab-config.<DAB_ENVIRONMENT>.json sürece DAB_ENVIRONMENT olarak ayarlanır.

Example

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

--otel-enabled

OpenTelemetry verme işlemini etkinleştirin veya devre dışı bırakın. Kabul edilen değerler: true, false.

Example

dab add-telemetry \
  --otel-enabled true

Sonuçta elde edilen yapılandırma

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

--otel-endpoint

OpenTelemetry toplayıcınızın veya arka ucunuzun URL'si. gRPC için kullanın http://<host>:<port>. HTTP için tam yolu ekleyin, örneğin http://<host>:<port>/v1/traces.

Example

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

Sonuçta elde edilen yapılandırma

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

--otel-protocol

OpenTelemetry dışarı aktarıcısı için dışarı aktarma protokolü. İzin verilen değerler: grpc, httpprotobuf. Varsayılan olarak grpc değerini alır.

Example

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

Sonuçta elde edilen yapılandırma

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

--otel-service-name

Tüm izlemelere ve ölçümlere eklenmiş hizmet adı etiketi. Telemetri arka ucunuzda hizmet tanımlayıcısı olarak görünür. Varsayılan olarak dab değerini alır.

Example

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

Sonuçta elde edilen yapılandırma

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

--otel-headers

Telemetriyi toplayıcıya aktarırken eklenecek ek HTTP üst bilgileri. Virgülle ayrılmış key=value bir liste kullanın. API anahtarı veya yetkilendirme üst bilgisi gerektiren kimliği doğrulanmış toplayıcı uç noktaları için bu seçeneği kullanın.

Example

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

--app-insights-enabled

Azure Application Insights telemetrisini etkinleştirin veya devre dışı bırakın. Kabul edilen değerler: true, false.

Example

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

Sonuçta elde edilen yapılandırma

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

--app-insights-conn-string

Azure Application Insights kaynağınız için bağlantı dizesi. Gizli dizilerin kaynak denetimine işlenmesini önlemek için bir ortam değişkeni başvurusu kullanın.

Uyarı

Bağlantı dizesini hiçbir zaman doğrudan yapılandırma dosyanızda sabit kodlamayın. Veya gizli dizi yöneticisi kullanın @env('<variable-name>') .

Example

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

Sonuçta elde edilen yapılandırma

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

Tam örnek: OpenTelemetry ve Application Insights

Aşağıdaki örnek, tek bir komutta hem OpenTelemetry hem de Application Insights'ı etkinleştirir.

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

Sonuçta elde edilen yapılandırma

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

İlgili içerik

  • Last updated on