carbon-aware-sdk icon indicating copy to clipboard operation
carbon-aware-sdk copied to clipboard

Add configuration for tracing log

Open YaSuenag opened this issue 8 months ago • 1 comments

Pull Request

Summary

Introduce new configuration EnableTelemetryLogging into CarbonAwareVars. This configures whether console exporter by OpenTelemetry is enabled. If you set this to false, following log would be gone:

Activity.TraceId:            46ba0749bdd2381c8f8aded1986e74b2
Activity.SpanId:             bcb76b5718c7df35
Activity.TraceFlags:         Recorded
Activity.ActivitySourceName: Microsoft.AspNetCore
Activity.DisplayName:        /health
Activity.Kind:               Server
Activity.StartTime:          2024-06-12T10:36:51.3093434Z
Activity.Duration:           00:00:00.0221267
Activity.Tags:
    net.host.name: localhost
    net.host.port: 8080
    http.method: GET
    http.scheme: http
    http.target: /health
    http.url: http://localhost:8080/health
    http.flavor: 1.1
    http.user_agent: curl/8.5.0
    http.status_code: 200
Resource associated with Activity:
    service.name: CarbonAware.WebAPI
    service.version: 1.0.0
    service.instance.id: d482b5d5-4448-4281-8da8-37677e70e389
    telemetry.sdk.name: opentelemetry
    telemetry.sdk.language: dotnet
    telemetry.sdk.version: 1.6.0

This configuration is set to true by default, so this change does not change current behavior.

Changes

  • Add EnableTelemetryLogging
  • Move console exporter configuration to ServiceCollectionExtensions.cs from Program.cs
  • Update document
  • Update unit test

Checklist

  • [x] Local Tests Passing?
  • [ ] CICD and Pipeline Tests Passing?
  • [x] Added any new Tests?
  • [x] Documentation Updates Made?
  • [ ] Are there any API Changes? If yes, please describe below.
  • [ ] This is not a breaking change. If it is, please describe it below.

Are there API Changes?

No

Is this a breaking change?

No

YaSuenag avatar Jun 12 '24 10:06 YaSuenag