Configure third party tools by using the CLI

You can use the obs-cli.sh script to manage gateway hosts, exporters, and processors from the command-line interface.

Manage gateway hosts
1. List configured gateway hosts ./obs-cli.sh get-gateway-hosts
2. List all cluster hosts and their gateway status ./obs-cli.sh list-hosts --url http://cm-host:7180 --user admin --pass secret
3. Add gateway hosts ./obs-cli.sh add-gateway-host --host [***HOST-NAME***]
4. Remove gateway hosts ./obs-cli.sh remove-gateway-host --host [***HOST-NAME***]
Manage extensions (Optional: required only if exporter configuration requires authentication)
1. List extensions for hosts: ./obs-cli.sh list-extensions
2. Add extension definitions only ./obs-cli.sh add-extension --file extension-add.yaml
3. Update existing extension(s) from YAML ./obs-cli.sh update-extension --file ./examples/extension-update.yaml
4. Remove extensions entirely (definition + all pipeline links): ./obs-cli.sh remove-extension --extension cdpauth/example-1
  Example extension YAML:
```
cdpauth/example-1:
  cdp_access_key_id: CDP_ACCESS_KEY_ID
  send_token: true
  token_valid_for_sec: 3600
  cdp_private_key: CDP_PRIVATE_KEY
  cdp_authentication_method: 'rsav1'
```
```
basicauth/self-metrics:
  client_auth:
    username: USER_NAME
    password: PASSWORD
```
Manage exporters
1. Display raw exporter and service configurations from Cloudera Manager ./obs-cli.sh get-metric-configs
2. List exporters ./obs-cli.sh list-exporters
3. Add exporters from a YAML file ./obs-cli.sh add-exporter --file ./examples/exporter-add.yaml --debug
4. Update existing exporters from a YAML file ./obs-cli.sh update-exporter --file ./examples/exporter-update.yaml
5. Remove exporters ./obs-cli.sh remove-exporter --exporter [***EXPORTER-NAME***]
Example exporter YAML:
```
prometheusremotewrite/my-exporter:
  endpoint: "https://receive.example.com/api/v1/receive"
  retry_on_failure:
    enabled: true
    initial_interval: 10s
    max_interval: 40s
    max_elapsed_time: 300s
  auth:
    authenticator: cdpauth/gateway
```
```
otlp/secure:
  endpoint: "api.your-observability-backend.com:4317"
  headers:
    "api-key": "your-secret-api-key"
  tls:
    insecure: false
```
Manage processors (Optional)
1. List processors and their pipeline connections ./obs-cli.sh list-processors
2. Add processor definitions only ./obs-cli.sh add-processor --file ./examples/processor-add.yaml
3. Add processor definitions and link them to exporter pipelines ./obs-cli.sh add-processor --file ./examples/processor-add.yaml --exporter prometheusremotewrite/priv
4. Link existing processors to exporter pipelines ./obs-cli.sh add-processor --processor batch/customer --exporter otlp/custom
5. Update existing processors from a YAML file ./obs-cli.sh update-processor --file ./examples/processor-update.yaml
6. Remove processors entirely ./obs-cli.sh remove-processor --processor batch/customer
7. Unlink processors from specific exporter pipelines ./obs-cli.sh remove-processor --processor batch/customer --exporter otlp/custom
```
  attributes/test_marker:
    actions:
      - key: environment
        value: testing
        action: insert
```

After you apply these changes, metrics from your Cloudera Base on premises deployment flow to each configured external destination. You can view and query metrics directly on your chosen observability platform alongside the data delivered to the existing SaaS gateway. To track the health of the export pipeline, import the provided health dashboard (obs-health-dashboard.json) into Grafana to view collector throughput, delivery success, and errors across your OpenTelemetry pipeline connections.