[GEN-2217]: enhance destinations documentation auto-generation script

destinations/data/appdynamics.yaml

@@ -20,6 +20,7 @@ spec:
       componentProps:
         type: text
         required: false
+        tooltip: 'Will define a namespace in AppDynamics'
     - name: APPDYNAMICS_ACCOUNT_NAME
       displayName: Account Name
       componentType: input

destinations/data/s3.yaml → destinations/data/awss3.yaml

@@ -20,12 +20,14 @@ spec:
       componentProps:
         type: text
         required: true
+        tooltip: The name of the bucket where the data will be stored
     - name: S3_REGION
       displayName: Bucket Region
       componentType: input
       componentProps:
         type: text
         required: true
+        tooltip: The AWS region where the bucket is located
     - name: S3_PARTITION
       displayName: Time granularity of S3 Bucket
       componentType: dropdown
@@ -34,6 +36,7 @@ spec:
           - minute
           - hour
         required: true
+        tooltip: Wether a new subdirectory should be created every minute or every hour
       initialValue: minute
     - name: S3_MARSHALER
       displayName: Marshaller (Data Format)
@@ -43,4 +46,5 @@ spec:
           - otlp_json
           - otlp_proto
         required: true
+        tooltip: The format in which the data will be encoded. It can be either `otlp_json` or `otlp_proto`. Default is `otlp_json`
       initialValue: otlp_json

destinations/data/betterstack.yaml

@@ -21,3 +21,7 @@ spec:
       componentProps:
         type: password
         required: true
+  note: |
+    We handle the endpoint internally, so you don't need to provide it.
+    - The endpoint for metrics is `https://in-otel.logs.betterstack.com/metrics`
+    - The endpoint for logs is `https://in-otel.logs.betterstack.com:443`

destinations/data/causely.yaml

@@ -18,3 +18,5 @@ spec:
       componentProps:
         type: text
         required: true
+        placeholder: http://mediator.causely:4317
+        tooltip: 'The endpoint URL is the combined `<protocol>://<hostname>:<port>` to access your Causely Mediator service. Protocol should be `http`; using `https` or omitting it will automatically be converted to `http`. Hostname should typically follow the format: `mediator.<namespace>`. Namespace is the k8s namespace where the Causely Mediator service is deployed. Port is optional and defaults to the default OTLP gRPC port `4317`'

destinations/data/chronosphere.yaml

@@ -20,12 +20,12 @@ spec:
       componentProps:
         type: text
         required: true
-        tooltip: 'Company domain in Chronosphere, can be found in the URL (my-company.chronosphere.io)'
+        tooltip: 'Company domain in Chronosphere, can be found in the URL of the Chronosphere UI. For example, if your URL is `https://demo-sandbox.chronosphere.io/`, then your company domain is `demo-sandbox`'
     - name: CHRONOSPHERE_API_TOKEN
       displayName: API Token
       componentType: input
       componentProps:
         type: password
         required: true
-        tooltip: 'API token generated from your Chronosphere service account in the Chronosphere admin UI'
+        tooltip: 'API token generated from your Chronosphere service account in the Chronosphere UI, you should login to your Chronosphere admin account click the `Platform` menu on the left side of the screen, then click `Service Accounts` and create a new service account'
       secret: true

destinations/data/clickhouse.yaml

@@ -21,7 +21,7 @@ spec:
         type: text
         required: true
         placeholder: 'http://host:port'
-        tooltip: 'Clickhouse server address'
+        tooltip: 'The ClickHouse endpoint is the URL where the ClickHouse server is listening for incoming connections.'
     - name: CLICKHOUSE_USERNAME
       displayName: Username
       componentType: input
@@ -42,15 +42,15 @@ spec:
       componentType: checkbox
       componentProps:
         required: true
-        tooltip: 'Should the destination create the schema for you?'
+        tooltip: 'Should the destination create the schema for you? Set to `false` if you manage your own schema, or `true` to have Odigos create the schema for you'
       initialValue: true
     - name: CLICKHOUSE_DATABASE_NAME
       displayName: Database Name
       componentType: input
       componentProps:
         type: text
         required: true
-        tooltip: 'Name of the ClickHouse Database to use, which you should have created already'
+        tooltip: 'The name of the Clickhouse Database where the telemetry data will be stored. The Database will not be created when not exists, so make sure you have created it before'
       initialValue: otel
     - name: CLICKHOUSE_TRACES_TABLE
       displayName: Traces Table

destinations/data/coralogix.yaml

@@ -20,6 +20,7 @@ spec:
       componentProps:
         type: password
         required: true
+        tooltip: 'The Send-Your-Data API Key is used to authenticate the data sent to Coralogix.'
       secret: true
     - name: CORALOGIX_DOMAIN
       displayName: Domain
@@ -33,15 +34,18 @@ spec:
           - coralogix.in
           - coralogixsg.com
         required: true
+        tooltip: 'The Coralogix domain to which you want to send the data.'
     - name: CORALOGIX_APPLICATION_NAME
       displayName: Application Name
       componentType: input
       componentProps:
         type: text
         required: true
+        tooltip: 'The name of the application that sends the data to Coralogix.'
     - name: CORALOGIX_SUBSYSTEM_NAME
       displayName: Subsystem Name
       componentType: input
       componentProps:
         type: text
         required: true
+        tooltip: 'The name of the subsystem that sends the data to Coralogix.'

destinations/data/dash0.yaml

@@ -20,10 +20,12 @@ spec:
       componentProps:
         type: text
         required: true
+        tooltip: The format is `host:port`. Host is required, located in Dash0 UI (OpenTelemetry Collector). Port is optional and defaults to the default OTLP gRPC port `4317`.
     - name: DASH0_TOKEN
       displayName: Dash0 Bearer Token
       componentType: input
       secret: true
       componentProps:
         type: password
         required: true
+        tooltip: Located in Dash0 UI (OpenTelemetry Collector).

destinations/data/datadog.yaml

@@ -17,10 +17,11 @@ spec:
     - name: DATADOG_API_KEY
       displayName: API Key
       componentType: input
+      secret: true
       componentProps:
         type: password
         required: true
-      secret: true
+        tooltip: The API key for your Datadog account.
     - name: DATADOG_SITE
       displayName: Site
       componentType: dropdown
@@ -33,3 +34,4 @@ spec:
           - ddog-gov.com
           - ap1.datadoghq.com
         required: true
+        tooltip: The datadog site you are using (the url of the datadog site you are using).

destinations/data/dynatrace.yaml

@@ -20,6 +20,7 @@ spec:
       componentProps:
         type: text
         required: true
+        placeholder: https://{your-environment-id}.live.dynatrace.com
     - name: DYNATRACE_API_TOKEN
       displayName: API Access Token
       componentType: input

destinations/data/elasticsearch.yaml

@@ -21,21 +21,21 @@ spec:
         type: text
         required: true
         placeholder: 'http://host:port'
-        tooltip: 'Elasticsearch endpoint. port defaults to 9200 if not specified'
+        tooltip: 'Elasticsearch endpoint. Port defaults to `9200` if not specified'
     - name: ES_TRACES_INDEX
       displayName: Traces Index
       componentType: input
+      initialValue: 'trace_index'
       componentProps:
         type: text
-        placeholder: 'trace_index'
-        tooltip: 'The name of the index where traces will be stored. Defaults to trace_index'
+        tooltip: 'The name of the index where traces will be stored'
     - name: ES_LOGS_INDEX
       displayName: Logs Index
       componentType: input
+      initialValue: 'log_index'
       componentProps:
         type: text
-        placeholder: 'log_index'
-        tooltip: 'The name of the index where logs will be stored. Defaults to log_index'
+        tooltip: 'The name of the index where logs will be stored.'
     - name: ELASTICSEARCH_BASIC_AUTH_ENABLED
       displayName: Enable HTTP Basic Authentication
       componentType: checkbox

destinations/data/gigapipe.yaml

@@ -16,32 +16,36 @@ spec:
   fields:
     - name: QRYN_API_SECRET
       displayName: API Secret
+      secret: true
       componentType: input
       componentProps:
         type: password
         required: true
-      secret: true
+        tooltip: The API Secret for your Gigapipe Account
     - name: QRYN_API_KEY
       displayName: API Key
       componentType: input
       componentProps:
         type: password
         required: true
+        tooltip: The API Token for your Gigapipe Account
     - name: QRYN_URL
       displayName: API Url
       componentType: input
       componentProps:
         type: text
         required: true
+        tooltip: The API Endpoint for your Gigapipe Account
+        placeholder: https://your-account.gigapipe.com
     - name: QRYN_RESOURCE_TO_TELEMETRY_CONVERSION
       displayName: Convert container attributes to labels
       componentType: checkbox
+      initialValue: true
       componentProps:
         required: false
-      initialValue: Yes
     - name: QRYN_ADD_EXPORTER_NAME
       displayName: Add exporter name to labels
       componentType: checkbox
+      initialValue: true
       componentProps:
         required: false
-      initialValue: Yes

destinations/data/grafanacloudloki.yaml

@@ -20,25 +20,25 @@ spec:
       componentProps:
         type: text
         required: true
-        placeholder: https://logs-prod-012.grafana.net
         tooltip: The endpoint of your Grafana Cloud Loki instance
+        placeholder: https://logs-prod-{REGION/SHARD}.grafana.net/loki/api/v1/push
     - name: GRAFANA_CLOUD_LOKI_USERNAME
       displayName: Username
       componentType: input
       componentProps:
         type: text
         required: true
         placeholder: 1234567
-        tooltip: The user of your Grafana Cloud Loki instance
+        tooltip: You can find the loki username in the "Grafana Data Source settings" section as "User" value. The username is a number.
     - name: GRAFANA_CLOUD_LOKI_PASSWORD
       displayName: Password (Api Token)
+      secret: true
       componentType: input
       componentProps:
         type: password
         required: true
+        tooltip: This field is refered to as "password" or "Grafana.com API Token" in the Grafana Cloud UI. You can manage tokens in your "Account Settings" page under the "SECURITY" section in the "Access Policies" page. Make sure your token scope includes `logs:write` scope
         placeholder: glc_eyJvIj...
-        tooltip: Grafana Cloud API Token with 'logs:write' permission
-      secret: true
     - name: GRAFANA_CLOUD_LOKI_LABELS
       displayName: Labels
       componentType: multiInput

destinations/data/grafanacloudprometheus.yaml

@@ -20,25 +20,25 @@ spec:
       componentProps:
         type: text
         required: true
-        placeholder: 'e.g https://prometheus-us-central1.grafana.net/api/prom/push'
-        tooltip: 'Grafana Cloud Prometheus remote write endpoint'
+        placeholder: 'https://{hostname}.grafana.net/api/prom/push'
+        tooltip: This is the URL of the Prometheus service. From the grafana cloud UI, Prometheus page, make sure you copy the URL from “Remote Write Endpoint” section, and not the first Endpoint which is used for queries
     - name: GRAFANA_CLOUD_PROMETHEUS_USERNAME
       displayName: Username / Instance ID
       componentType: input
       componentProps:
         type: text
         required: true
         placeholder: '12345678'
-        tooltip: 'Grafana Cloud Prometheus instance ID'
+        tooltip: 'You can find the Username / Instance ID on the Prometheus page. Value is a number.'
     - name: GRAFANA_CLOUD_PROMETHEUS_PASSWORD
       displayName: Password / Api Token
+      secret: true
       componentType: input
       componentProps:
         type: password
         required: true
+        tooltip: This field is refered to as "password" or "Grafana.com API Token" in the Grafana Cloud UI. You can manage tokens in your "Account Settings" page under the "SECURITY" section in the "Access Policies" page. Make sure your token scope includes `metrics:write` scope.
         placeholder: 'glc_eyJvIj...'
-        tooltip: "Grafana Cloud API Token with 'metrics:write' permission"
-      secret: true
     - name: PROMETHEUS_RESOURCE_ATTRIBUTES_LABELS
       displayName: Resource Attributes Labels
       componentType: multiInput

destinations/data/grafanacloudtempo.yaml

@@ -15,21 +15,26 @@ spec:
       supported: false
   fields:
     - name: GRAFANA_CLOUD_TEMPO_ENDPOINT
-      displayName: Endpoint (host:port)
+      displayName: Endpoint
       componentType: input
       componentProps:
         type: text
         required: true
+        tooltip: This is the URL of the Tempo service, in the form of `host:port`. You can find the endpoint under the "Sending data to Tempo" section.
+        placeholder: tempo-us-central1.grafana.net:443
     - name: GRAFANA_CLOUD_TEMPO_USERNAME
       displayName: Username
       componentType: input
       componentProps:
         type: text
         required: true
+        tooltip: You can find the username in the "Sending data to Tempo" section under the "basic_auth" yaml field. The username is a number.
     - name: GRAFANA_CLOUD_TEMPO_PASSWORD
       displayName: Password (Api Token)
+      secret: true
       componentType: input
       componentProps:
         type: password
         required: true
-      secret: true
+        tooltip: This field is refered to as "password" or "Grafana.com API Token" in the Grafana Cloud UI. You can manage tokens in your "Account Settings" page under the "SECURITY" section in the "Access Policies" page. Make sure your token scope includes `traces:write` scope.
+        placeholder: 'glc_eyJvIj...'

destinations/data/groundcover.yaml

@@ -20,7 +20,7 @@ spec:
       componentProps:
         type: text
         required: true
-        tooltip: 'Your inCloud Site is part of the configuration provided to you by groundcover when setting up the managed inCloud backend.'
+        tooltip: The format is `host:port`. Host is required, also known as your `inCloud_Site`, it is part of the configuration provided to you by Groundcover when setting up inCloud Managed. Port is optional, and defaults to the default OpenTelemetry gRPC port `4317`.
     - name: GROUNDCOVER_API_KEY
       displayName: Groundcover API Key
       componentType: input

destinations/data/honeycomb.yaml

@@ -29,3 +29,4 @@ spec:
           - api.honeycomb.io
           - api.eu1.honeycomb.io
         required: true
+        tooltip: Choose one of the endpoints in the dropdown (`api.honeycomb.io` is the US instance, `api.eu1.honeycomb.io` is EU instance)

destinations/data/hyperdx.yaml

@@ -21,3 +21,6 @@ spec:
       componentProps:
         type: password
         required: true
+  note: |
+    We handle the endpoint internally, so you don't need to provide it.
+    - The endpoint is `in-otel.hyperdx.io:4317`

destinations/data/jaeger.yaml

@@ -18,15 +18,15 @@ spec:
       displayName: Jaeger OTLP gRPC Endpoint
       componentType: input
       componentProps:
-        type: text
         required: true
+        tooltip: The format is `host:port`, host is required, port is optional and defaults to the default OTLP gRPC port `4317`
     - name: JAEGER_TLS_ENABLED
       displayName: Enable TLS
       componentType: checkbox
       initialValue: false
       componentProps:
         required: false
-        tooltip: 'Secure connection (Transport Layer Security)'
+        tooltip: 'Secure connection'
       customReadDataLabels:
         - condition: 'true'
           title: 'TLS'
@@ -38,10 +38,9 @@ spec:
       displayName: Certificate Authority
       componentType: textarea
       componentProps:
-        type: text
         required: false
         placeholder: '-----BEGIN CERTIFICATE-----'
-        tooltip: 'When using TLS, provide the CA certificate to verify the server. If empty uses system root CA'
+        tooltip: 'When using TLS, provide the CA certificate in PEM format to verify the server. If empty uses system root CA'
       renderCondition: ['JAEGER_TLS_ENABLED', '==', 'true']
       hideFromReadData: ['true']
   testConnectionSupported: true

destinations/data/kloudmate.yaml

@@ -21,3 +21,6 @@ spec:
       componentProps:
         type: password
         required: true
+  note: |
+    We handle the endpoint internally, so you don't need to provide it.
+    - The endpoint is `https://otel.kloudmate.com:4318`

destinations/data/last9.yaml

@@ -20,12 +20,11 @@ spec:
       componentProps:
         type: text
         required: true
-        tooltip: 'Last9 OpenTelemetry Endpoint. Can be found at https://app.last9.io/integrations?category=all&integration=OpenTelemetry'
     - name: LAST9_OTLP_BASIC_AUTH_HEADER
       displayName: Basic Auth Header
       componentType: input
       secret: true
       componentProps:
         type: password
         required: true
-        placeholder: "Basic ..."
+        placeholder: 'Basic ...'