Syslog Exporter Unavailable In Container Builds

[TaylorWork]

Component(s)

exporter/syslog

Describe the issue you're reporting

I've been trying to make use of the syslog exporter that was added in 0.78.0, however when deploying the docker image for opentelemetry-collector-contrib, the syslog exporter doesn't seem to be available.

I've tried both the 0.78.0 container build and the 0.83.0 build, and both of them produce the below error.

* error decoding 'exporters': unknown type: "syslog" for id: "syslog" (valid values: [f5cloud opencensus logzio zipkin logging awscloudwatchlogs awsemf elasticsearch jaeger_thrift kafka logicmonitor prometheus awskinesis awsxray azuredataexplorer datadog dynatrace googlemanagedprometheus tanzuobservability otlp carbon clickhouse sentry alibabacloud_logservice jaeger prometheusremotewrite sapm otlphttp coralogix dataset googlecloud loki mezmo pulsar sumologic awss3 azuremonitor file googlecloudpubsub influxdb instana tencentcloud_logservice loadbalancing signalfx skywalking splunk_hec])

For the configuration I am following the guidance from the below:

• https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.83.0/exporter/syslogexporter
• https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.83.0/exporter/syslogexporter/examples/config_with_filelog_receiver.yaml

My config:

    extensions:
      file_storage/syslog:
        directory: /tmp/otc
        timeout: 10s
    exporters:
      syslog:
        network: tcp
        port: 514
        endpoint: syslog-endpoint.local
        format: rfc5424
        retry_on_failure:
          enabled: true
          initial_interval: 5s
          max_interval: 30s
        sending_queue:
          enabled: true
          storage: file_storage/syslog
    receivers:
      otlp/container-logs:
        protocols:
          grpc:
            endpoint: "0.0.0.0:4317"
        operators:
          - type: syslog_parser
            protocol: rfc5424
      otlp/other-logs:
        protocols:
          grpc:
            endpoint: "0.0.0.0:4318"
        operators:
          - type: syslog_parser
            protocol: rfc5424
    service:
      extensions:
        - file_storage/syslog
      pipelines:
        logs:
          exporters:
            - syslog
          receivers:
            - otlp/container-logs
            - otlp/other-logs

[github-actions]

Pinging code owners:

• exporter/syslog: @kkujawa-sumo @rnishtala-sumo @astencel-sumo

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

[crobert-1]

This exporter is not included in the released distribution at this time. (Check here for current exporters included in released versions of the contrib collector.) You could use it by running directly from the repository, but not released versions of the collector.

The syslog exporter is labeled as being at the Development stability level, meaning it's likely not ready for release yet.

I'll defer to the codeowners regarding plans for releasing this component.

[crobert-1]

/label -needs-triage

[andrzej-stencel]

@crobert-1 is correct, there are a couple issues to be completed before the Syslog exporter is included in contrib:

• [exporter/syslog] Improve documentation #21242
• [exporter/syslog] Performance improvements #21244
• [exporter/syslog] Add integration tests #21245
• syslog_parser with syslog exporter results in logs like 2023-08-09T06:34:49.490942+00:00 ip-10-82-103-213.ap-southeast-2.compute.internal %!d(<nil>) 2023-08-09T06:34:48Z %!s(<nil>) %!s(<nil>) %!s(<nil>) %!s(<nil>) - %!s(<nil>) #25114

Work on these issues is planned from the code owners, but I cannot commit to any dates at this point.