Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 1.74 KB

README.md

File metadata and controls

65 lines (47 loc) · 1.74 KB

Scaleway Audit Trail receiver

The Scaleway Audit Trail receiver collects audit trail events from your scaleway organization.

Builder

To use this component with a custom OpenTelemetry Collector distribution, add the following configuration:

receivers:
  - gomod: github.com/scaleway/opentelemetry-collector-scaleway/receiver/scwaudittrail v0.1.0

Update the tag according to the latest release of this repository.

Configuration

The following config is required:

  • access_key Scaleway access key (from API key)
  • secret_key Scaleway secret key (from api key)
  • organization_id Scaleway organization ID to monitor
  • region Scaleway region to monitor

The following config is optional:

  • interval Polling frequency (defaults to 1 minute, must be at least 1 minute)
  • max_events_per_request Number of events to process per poll (defaults to 100)

Examples:

  scwaudittrail:
    access_key: ${env:SCW_ACCESS_KEY}
    secret_key: ${env:SCW_ACCESS_KEY}
    organization_id: ${env:SCW_DEFAULT_ORGANIZATION_ID}
    region: ${env:SCW_DEFAULT_REGION}

The full list of settings exposed for this receiver are documented in config.go.

Examples

Here is an example configuration for the collector using this receiver and the OTLP Exporter.

receivers:
  scwaudittrail:
    access_key: ${env:SCW_ACCESS_KEY}
    secret_key: ${env:SCW_ACCESS_KEY}
    organization_id: ${env:SCW_DEFAULT_ORGANIZATION_ID}
    region: ${env:SCW_DEFAULT_REGION}

exporters:
  otlp:
    endpoint: <OTLP_ENDPOINT>
    tls:
      insecure: true

service:
  pipelines:
    logs:
      receivers: [scwaudittrail]
      exporters: [otlp]