Skip to content

Commit

Permalink
[chore]: Document logs_index of OpensearchExporter
Browse files Browse the repository at this point in the history
Signed-off-by: Arpit Agarwal <arpitjindal97@gmail.com>
  • Loading branch information
arpitjindal97 committed Jun 5, 2024
1 parent 9815a65 commit 2bed5c1
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions exporter/opensearchexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,15 @@ The documents are sent using [observability catalog](https://github.com/opensear

## Configuration options
### Indexing Options
The Observability indices would follow the recommended pattern for immutable data stream ingestion using
the [data_stream](https://opensearch.org/docs/latest/dashboards/im-dashboards/datastream) concepts.
Index pattern will follow the next naming template `ss4o_{type}-{dataset}-{namespace}`
- `dataset` (default=`default`) a user-provided label to classify source of telemetry. It is used to construct the name of the destination index or data stream.
- `namespace` (default=`namespace`) a user-provided label to group telemetry. It is used to construct the name of the destination index or data stream.

LogsIndex configures the index, index alias, or data stream name logs should be indexed in.
- `logs_index` a user-provided label to specify name of the destination index or data stream.

### HTTP Connection Options
OpenSearch export supports standard [HTTP client settings](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp#client-configuration).
- `http.endpoint` (required) `<url>:<port>` of OpenSearch node to send data to.
Expand Down

0 comments on commit 2bed5c1

Please sign in to comment.