mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-08 19:29:07 +00:00
ef83f6d7d5
* Added metrics section to Aggregate processor page. Signed-off-by: carolxob <carolxob@amazon.com> * Added Metrics section to individual Processors pages. Signed-off-by: carolxob <carolxob@amazon.com> * Added metrics section for JSON processor. Signed-off-by: carolxob <carolxob@amazon.com> * Added metrics sections. Changed Default is to Default value is. Signed-off-by: carolxob <carolxob@amazon.com> * Corrected references from AWS S3 to Amazon S3. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to Metrics sections and phrasing. Signed-off-by: carolxob <carolxob@amazon.com> * Updated Action link. Signed-off-by: carolxob <carolxob@amazon.com> * Updates based on tech review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Updates based on tech review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Tech review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to buffer_size and batch_size default values. Signed-off-by: carolxob <carolxob@amazon.com> * Edits to Metrics sections for each processor. Signed-off-by: carolxob <carolxob@amazon.com> * Update made based ondoc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to intro text for processor pages. Minor adjustements to other text for clarity. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Adjustements to phrasing, fixed typos. Signed-off-by: carolxob <carolxob@amazon.com> * Minor updates to word choice and corrected a typo. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edit. Signed-off-by: carolxob <carolxob@amazon.com> * Made updates based ondoc review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Updates to http-source. Signed-off-by: carolxob <carolxob@amazon.com> * Added common processors table to affected docs. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update to one file. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update based on tech review feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Major editorial feedback incorporated through key-value.md. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated major editorial feedback thup to service-map-stateful. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated major editorial feedback for Processors section. Signed-off-by: carolxob <carolxob@amazon.com> * Major editorial updates, specifically to inclusion of text introducing option configuration tables. Signed-off-by: carolxob <carolxob@amazon.com> * Major editorial feedback through otel-trace.md incorporated. Signed-off-by: carolxob <carolxob@amazon.com> * Major editorial edits incorporated. Signed-off-by: carolxob <carolxob@amazon.com> * Technical feedback and editorial feedback incorporated. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated missing editorial feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor adjustements to OpenSearch sink. Signed-off-by: carolxob <carolxob@amazon.com> * Minor changes to capitalization. Signed-off-by: carolxob <carolxob@amazon.com> * Minor edits. Signed-off-by: carolxob <carolxob@amazon.com> * Made one instance of processor name consistent with other references. Signed-off-by: carolxob <carolxob@amazon.com> * Minor update based on editorial feedback. Signed-off-by: carolxob <carolxob@amazon.com> --------- Signed-off-by: carolxob <carolxob@amazon.com>
58 lines
4.3 KiB
Markdown
58 lines
4.3 KiB
Markdown
---
|
|
layout: default
|
|
title: otel_trace_source source
|
|
parent: Sources
|
|
grand_parent: Pipelines
|
|
nav_order: 15
|
|
---
|
|
|
|
|
|
# otel_trace source
|
|
|
|
## Overview
|
|
|
|
The `otel_trace` source is a source for the OpenTelemetry Collector. The following table describes options you can use to configure the `otel_trace` source.
|
|
|
|
<!--- What does otel_trace_source do? Other plugins include that in the overview section.--->
|
|
|
|
Option | Required | Type | Description
|
|
:--- | :--- | :--- | :---
|
|
port | No | Integer | The port that the `otel_trace` source runs on. Default value is `21890`.
|
|
request_timeout | No | Integer | The request timeout, in milliseconds. Default value is `10000`.
|
|
health_check_service | No | Boolean | Enables a gRPC health check service under `grpc.health.v1/Health/Check`. Default value is `false`.
|
|
unauthenticated_health_check | No | Boolean | Determines whether or not authentication is required on the health check endpoint. Data Prepper ignores this option if no authentication is defined. Default value is `false`.
|
|
proto_reflection_service | No | Boolean | Enables a reflection service for Protobuf services (see [gRPC reflection](https://github.com/grpc/grpc/blob/master/doc/server-reflection.md) and [gRPC Server Reflection Tutorial](https://github.com/grpc/grpc-java/blob/master/documentation/server-reflection-tutorial.md) docs). Default value is `false`.
|
|
unframed_requests | No | Boolean | Enable requests not framed using the gRPC wire protocol.
|
|
thread_count | No | Integer | The number of threads to keep in the ScheduledThreadPool. Default value is `200`.
|
|
max_connection_count | No | Integer | The maximum allowed number of open connections. Default value is `500`.
|
|
ssl | No | Boolean | Enables connections to the OTel source port over TLS/SSL. Defaults to `true`.
|
|
sslKeyCertChainFile | Conditionally | String | File system path or Amazon Simple Storage Service (Amazon S3) path to the security certificate (for example, `"config/demo-data-prepper.crt"` or `"s3://my-secrets-bucket/demo-data-prepper.crt"`). Required if `ssl` is set to `true`.
|
|
sslKeyFile | Conditionally | String | File system path or Amazon S3 path to the security key (for example, `"config/demo-data-prepper.key"` or `"s3://my-secrets-bucket/demo-data-prepper.key"`). Required if `ssl` is set to `true`.
|
|
useAcmCertForSSL | No | Boolean | Whether to enable TLS/SSL using a certificate and private key from AWS Certificate Manager (ACM). Default value is `false`.
|
|
acmCertificateArn | Conditionally | String | Represents the ACM certificate ARN. ACM certificate take preference over S3 or local file system certificate. Required if `useAcmCertForSSL` is set to `true`.
|
|
awsRegion | Conditionally | String | Represents the AWS region used by ACM or Amazon S3. Required if `useAcmCertForSSL` is set to `true` or `sslKeyCertChainFile` and `sslKeyFile` are Amazon S3 paths.
|
|
authentication | No | Object | An authentication configuration. By default, an unauthenticated server is created for the pipeline. This parameter uses pluggable authentication for HTTPS. To use basic authentication, define the `http_basic` plugin with a `username` and `password`. To provide customer authentication, use or create a plugin that implements [GrpcAuthenticationProvider](https://github.com/opensearch-project/data-prepper/blob/main/data-prepper-plugins/armeria-common/src/main/java/com/amazon/dataprepper/armeria/authentication/GrpcAuthenticationProvider.java).
|
|
|
|
|
|
<!--- ## Configuration
|
|
|
|
Content will be added to this section.--->
|
|
|
|
## Metrics
|
|
|
|
### Counters
|
|
|
|
- `requestTimeouts`: Measures the total number of requests that time out.
|
|
- `requestsReceived`: Measures the total number of requests received by the `otel_trace` source.
|
|
- `successRequests`: Measures the total number of requests successfully processed by the `otel_trace` source plugin.
|
|
- `badRequests`: Measures the total number of requests with an invalid format processed by the `otel_trace` source plugin.
|
|
- `requestsTooLarge`: Measures the total number of requests whose number of spans exceeds the buffer capacity.
|
|
- `internalServerError`: Measures the total number of requests processed by the `otel_trace` source with a custom exception type.
|
|
|
|
### Timers
|
|
|
|
- `requestProcessDuration`: Measures the latency of requests processed by the `otel_trace` source plugin in seconds.
|
|
|
|
### Distribution summaries
|
|
|
|
- `payloadSize`: Measures the incoming request payload size distribution in bytes. |