Skip to content

Commit

Permalink
Merge pull request #17 from splunk/cfg-metadata-july
Browse files Browse the repository at this point in the history
update cfg metadata
  • Loading branch information
theletterf authored Jul 24, 2023
2 parents 21c902f + db5c472 commit 8ee3044
Show file tree
Hide file tree
Showing 127 changed files with 6,576 additions and 6,567 deletions.
32 changes: 18 additions & 14 deletions cfg-metadata/exporter/awscloudwatchlogs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,26 @@ fields:
- name: retry_on_failure
type: exporterhelper.RetrySettings
kind: struct
doc: |
RetrySettings defines configuration for retrying batches in case of export failure.
The current supported strategy is exponential backoff.
fields:
- name: enabled
kind: bool
default: true
doc: |
Enabled indicates whether to not retry sending batches in case of export failure.
- name: initial_interval
type: time.Duration
kind: int64
default: 5s
doc: |
InitialInterval the time to wait after the first failure before retrying.
- name: randomization_factor
kind: float64
- name: multiplier
kind: float64
- name: max_interval
type: time.Duration
kind: int64
default: 30s
doc: |
MaxInterval is the upper bound on backoff interval. Once this value is reached the delay between
consecutive retries will always be `MaxInterval`.
- name: max_elapsed_time
type: time.Duration
kind: int64
default: 5m0s
doc: |
MaxElapsedTime is the maximum amount of time (including retries) spent trying to send a request/batch.
Once this value is reached, the data is discarded.
- name: log_group_name
kind: string
default: ""
Expand All @@ -59,6 +50,13 @@ fields:
doc: |
LogRetention is the option to set the log retention policy for the CloudWatch Log Group. Defaults to Never Expire if not specified or set to 0
Possible values are 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, or 3653
- name: tags
type: map[string]*string
kind: map
doc: |
Tags is the option to set tags for the CloudWatch Log Group. If specified, please add add at least 1 and at most 50 tags. Input is a string to string map like so: { 'key': 'value' }
Keys must be between 1-128 characters and follow the regex pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Values must be between 1-256 characters and follow the regex pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
- name: sending_queue
type: awscloudwatchlogsexporter.QueueSettings
kind: struct
Expand All @@ -68,7 +66,7 @@ fields:
fields:
- name: queue_size
kind: int
default: 5000
default: 1000
doc: |
QueueSize set the length of the sending queue
- name: num_workers
Expand Down Expand Up @@ -121,3 +119,9 @@ fields:
default: ""
doc: |
IAM role to upload segments to a different account.
- name: raw_log
kind: bool
default: false
doc: |
Export raw log string instead of log wrapper
Required for emf logs
30 changes: 29 additions & 1 deletion cfg-metadata/exporter/awsemf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ fields:
doc: |
Namespace is a container for CloudWatch metrics.
Metrics in different namespaces are isolated from each other.
- name: retain_initial_value_of_delta_metric
kind: bool
default: false
doc: |
RetainInitialValueOfDeltaMetric is the flag to signal that the initial value of a metric is a valid datapoint.
The default behavior is that the first value occurrence of a metric is set as the baseline for the calculation of
the delta to the next occurrence. With this flag set to true the exporter will instead use this first value as the
initial delta value. This is especially useful when handling low frequency metrics.
- name: dimension_rollup_option
kind: string
default: ZeroAndSingleDimensionRollup
Expand All @@ -83,6 +91,13 @@ fields:
doc: |
LogRetention is the option to set the log retention policy for the CloudWatch Log Group. Defaults to Never Expire if not specified or set to 0
Possible values are 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 2192, 2557, 2922, 3288, or 3653
- name: tags
type: map[string]*string
kind: map
doc: |
Tags is the option to set tags for the CloudWatch Log Group. If specified, please add at most 50 tags. Input is a string to string map like so: { 'key': 'value' }
Keys must be between 1-128 characters and follow the regex pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$
Values must be between 1-256 characters and follow the regex pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
- name: parse_json_encoded_attr_values
type: '[]string'
kind: slice
Expand Down Expand Up @@ -172,7 +187,7 @@ fields:
type: resourcetotelemetry.Settings
kind: struct
doc: |
ResourceToTelemetrySettings is the option for converting resource attrihutes to telemetry attributes.
ResourceToTelemetrySettings is an option for converting resource attrihutes to telemetry attributes.
"Enabled" - A boolean field to enable/disable this option. Default is `false`.
If enabled, all the resource attributes will be converted to metric labels by default.
fields:
Expand All @@ -181,3 +196,16 @@ fields:
default: false
doc: |
Enabled indicates whether to convert resource attributes to telemetry attributes. Default is `false`.
- name: detailed_metrics
kind: bool
default: false
doc: |
DetailedMetrics is an option for retaining detailed datapoint values in exported metrics (e.g instead of exporting a quantile as a statistical value,
preserve the quantile's population)
- name: version
kind: string
default: "1"
doc: |
Version is an option for sending metrics to CloudWatchLogs with Embedded Metric Format in selected version (with "_aws")
https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Specification.html#CloudWatch_Embedded_Metric_Format_Specification_structure
Otherwise, sending metrics as Embedded Metric Format version 0 (without "_aws")
32 changes: 5 additions & 27 deletions cfg-metadata/exporter/awskinesis.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,67 +6,45 @@ fields:
type: time.Duration
kind: int64
default: 5s
doc: |
Timeout is the timeout for every attempt to send data to the backend.
- name: sending_queue
type: exporterhelper.QueueSettings
kind: struct
doc: |
QueueSettings defines configuration for queueing batches before sending to the consumerSender.
fields:
- name: enabled
kind: bool
default: true
doc: |
Enabled indicates whether to not enqueue batches before sending to the consumerSender.
- name: num_consumers
kind: int
default: 10
doc: |
NumConsumers is the number of consumers from the queue.
- name: queue_size
kind: int
default: 5000
doc: |
QueueSize is the maximum number of batches allowed in queue at a given time.
default: 1000
- name: storage
type: '*component.ID'
kind: ptr
doc: |
StorageID if not empty, enables the persistent storage and uses the component specified
as a storage extension for the persistent queue
- name: retry_on_failure
type: exporterhelper.RetrySettings
kind: struct
doc: |
RetrySettings defines configuration for retrying batches in case of export failure.
The current supported strategy is exponential backoff.
fields:
- name: enabled
kind: bool
default: true
doc: |
Enabled indicates whether to not retry sending batches in case of export failure.
- name: initial_interval
type: time.Duration
kind: int64
default: 5s
doc: |
InitialInterval the time to wait after the first failure before retrying.
- name: randomization_factor
kind: float64
- name: multiplier
kind: float64
- name: max_interval
type: time.Duration
kind: int64
default: 30s
doc: |
MaxInterval is the upper bound on backoff interval. Once this value is reached the delay between
consecutive retries will always be `MaxInterval`.
- name: max_elapsed_time
type: time.Duration
kind: int64
default: 5m0s
doc: |
MaxElapsedTime is the maximum amount of time (including retries) spent trying to send a request/batch.
Once this value is reached, the data is discarded.
- name: encoding
type: awskinesisexporter.Encoding
kind: struct
Expand Down
38 changes: 38 additions & 0 deletions cfg-metadata/exporter/awsxray.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,41 @@ fields:
- name: aws_log_groups
type: '[]string'
kind: slice
- name: telemetry
type: telemetry.Config
kind: struct
doc: |
TelemetryConfig contains the options for telemetry collection.
fields:
- name: enabled
kind: bool
default: false
doc: |
Enabled determines whether any telemetry should be recorded.
- name: include_metadata
kind: bool
default: false
doc: |
IncludeMetadata determines whether metadata (instance ID, hostname, resourceARN)
should be included in the telemetry.
- name: contributors
type: '[]component.ID'
kind: slice
doc: |
Contributors can be used to explicitly define which X-Ray components are contributing to the telemetry.
If omitted, only X-Ray components with the same component.ID as the setup component will have access.
- name: hostname
kind: string
default: ""
doc: |
Hostname can be used to explicitly define the hostname associated with the telemetry.
- name: instance_id
kind: string
default: ""
doc: |
InstanceID can be used to explicitly define the instance ID associated with the telemetry.
- name: resource_arn
kind: string
default: ""
doc: |
ResourceARN can be used to explicitly define the resource ARN associated with the telemetry.
31 changes: 31 additions & 0 deletions cfg-metadata/exporter/cassandra.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
type: '*cassandraexporter.Config'
fields:
- name: dsn
kind: string
default: 127.0.0.1
- name: keyspace
kind: string
default: otel
- name: trace_table
kind: string
default: otel_spans
- name: logs_table
kind: string
default: otel_logs
- name: replication
type: cassandraexporter.Replication
kind: struct
fields:
- name: class
kind: string
default: SimpleStrategy
- name: replication_factor
kind: int
default: 1
- name: compression
type: cassandraexporter.Compression
kind: struct
fields:
- name: algorithm
kind: string
default: LZ4Compressor
49 changes: 28 additions & 21 deletions cfg-metadata/exporter/clickhouse.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,29 @@ fields:
type: time.Duration
kind: int64
default: 5s
doc: |
Timeout is the timeout for every attempt to send data to the backend.
- name: retry_on_failure
type: exporterhelper.RetrySettings
kind: struct
doc: |
RetrySettings defines configuration for retrying batches in case of export failure.
The current supported strategy is exponential backoff.
fields:
- name: enabled
kind: bool
default: true
doc: |
Enabled indicates whether to not retry sending batches in case of export failure.
- name: initial_interval
type: time.Duration
kind: int64
default: 5s
doc: |
InitialInterval the time to wait after the first failure before retrying.
- name: randomization_factor
kind: float64
- name: multiplier
kind: float64
- name: max_interval
type: time.Duration
kind: int64
default: 30s
doc: |
MaxInterval is the upper bound on backoff interval. Once this value is reached the delay between
consecutive retries will always be `MaxInterval`.
- name: max_elapsed_time
type: time.Duration
kind: int64
default: 5m0s
doc: |
MaxElapsedTime is the maximum amount of time (including retries) spent trying to send a request/batch.
Once this value is reached, the data is discarded.
- name: sending_queue
type: clickhouseexporter.QueueSettings
kind: struct
Expand All @@ -49,16 +38,34 @@ fields:
fields:
- name: queue_size
kind: int
default: 5000
default: 1000
doc: |
QueueSize set the length of the sending queue
- name: dsn
- name: endpoint
kind: string
default: ""
doc: |
DSN is the ClickHouse server Data Source Name.
For tcp protocol reference: [ClickHouse/clickhouse-go#dsn](https://github.com/ClickHouse/clickhouse-go#dsn).
For http protocol reference: [mailru/go-clickhouse/#dsn](https://github.com/mailru/go-clickhouse/#dsn).
Endpoint is the clickhouse endpoint.
- name: username
kind: string
default: ""
doc: |
Username is the authentication username.
- name: password
kind: string
default: ""
doc: |
Username is the authentication password.
- name: database
kind: string
default: default
doc: |
Database is the database name to export.
- name: connection_params
type: map[string]string
kind: map
doc: |
ConnectionParams is the extra connection parameters with map format. for example compression/dial_timeout
- name: logs_table_name
kind: string
default: otel_logs
Expand All @@ -76,6 +83,6 @@ fields:
MetricsTableName is the table name for metrics. default is `otel_metrics`.
- name: ttl_days
kind: uint
default: 7
default: 0
doc: |
TTLDays is The data time-to-live in days, 0 means no ttl.
Loading

0 comments on commit 8ee3044

Please sign in to comment.