[receiver/azuremonitor] failed to start "azuremonitor" receiver: secret can't be empty string

[dosingleton-gs]

Component(s)

receiver/azuremonitor

What happened?

Description

When configuring the azuremonitor receiver using the service principal setup for the azureauthextension the azuremonitor receiver does not start.

Steps to Reproduce

Run the following config, using an azure service principal setup in your env.

docker-compose.yml

services:
  otel-collector:
    image: ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:latest
    volumes:
      - ./configs/otel-collector-config.yaml:/etc/otelcol-contrib/config.yaml
    ports:
      - 13133:13133 # health_check extension
      - 4317:4317 # OTLP gRPC receiver
      - 4318:4318 # OTLP http receiver
    networks:
      - observability-network
    environment:
      - AZURE_CLIENT_ID=${AZURE_CLIENT_ID}
      - AZURE_CLIENT_SECRET=${AZURE_CLIENT_SECRET}
      - AZURE_TENANT_ID=${AZURE_TENANT_ID}
      - AZURE_SUBSCRIPTION_ID=${AZURE_SUBSCRIPTION_ID}

networks:
  observability-network:
    driver: bridge

Expected Result

The collector to start along with the azuremonitorreceiver.

Actual Result

Error:

Error: cannot start pipelines: failed to start "azuremonitor" receiver: secret can't be empty string

Collector version

v0.128.0

Environment information

Environment

OS: Windows (Host), Docker via WSL (Ubuntu)

OpenTelemetry Collector configuration

extensions:
  health_check: {}
  azureauth:
    service_principal:
      tenant_id: ${AZURE_TENANT_ID}
      client_id: ${AZURE_CLIENT_ID}
      client_secret: ${AZURE_CLIENT_SECRET}

receivers:
  otlp:
    protocols:
      grpc:
        endpoint: 0.0.0.0:4317
      http:
        endpoint: 0.0.0.0:4318
  azuremonitor:
    auth: 
      authenticator: azureauth
    use_batch_api: true
    discover_subscriptions: true

processors:
  batch:

exporters:
  debug:
    verbosity: detailed

service:
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [debug]
    metrics:
      receivers: [otlp, azuremonitor]
      exporters: [debug]
    logs:
      receivers: [otlp]
      processors: [batch]
      exporters: [debug]

  extensions: [health_check, azureauth]

Log output

Error: cannot start pipelines: failed to start "azuremonitor" receiver: secret can't be empty string

Additional context

No response

[github-actions]

Pinging code owners:

• receiver/azuremonitor: @nslaughter @celian-garcia

See Adding Labels via Comments if you do not have permissions to add labels yourself.

[axw]

It appears that "auth" config support has not been implemented for use_batch_api: true. See:

• opentelemetry-collector-contrib/receiver/azuremonitorreceiver/scraper.go

  Lines 173 to 183 in de465d2

  	func (s *azureScraper) loadCredentials(host component.Host) (err error) {
  	if s.cfg.Authentication != nil {
  	s.settings.Logger.Info("'auth.authenticator' will be used to get the token credential")
  	if s.cred, err = loadTokenProvider(host, s.cfg.Authentication.AuthenticatorID); err != nil {
  	return err
  	}
  	return nil
  	}
  	s.settings.Logger.Warn("'credentials' is deprecated, use 'auth.authenticator' instead")
  	switch s.cfg.Credentials {

• opentelemetry-collector-contrib/receiver/azuremonitorreceiver/scraper_batch.go

  Lines 113 to 115 in de465d2

  	// TODO: duplicate
  	func (s *azureBatchScraper) loadCredentials() (err error) {
  	switch s.cfg.Credentials {

[celian-garcia]

😲 oh sorry ! Yes definitely. For now you can still use the "deprecated" way, I didn't remove it yet hopefully.

I will not have time in very short term, but if you'd like to work on this, I think it's not complex. Otherwise I'll do it when the time permits.

[celian-garcia]

/labels -waiting-for-code-owners -needs-triage good-first-issue help-wanted

[axw]

@constanca-m FYI, since you did the initial work supporting azureauth and would like to take it

[constanca-m]

Thanks @axw for the ping. I will try to take a look @celian-garcia if I have time, indeed it seems simple to fix