Skip to content

Commit

Permalink
chore(docs): Add alpha to traces and beta to metrics in descriptions (#…
Browse files Browse the repository at this point in the history
…19139)

add alpha to traces and beta to metrics in descriptions
  • Loading branch information
maycmlee authored Nov 13, 2023
1 parent 913c2ae commit 8a1ed17
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
8 changes: 4 additions & 4 deletions src/sources/datadog_agent/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -87,20 +87,20 @@ pub struct DatadogAgentConfig {
#[serde(default = "crate::serde::default_false")]
disable_logs: bool,

/// If this is set to `true`, metrics are not accepted by the component.
/// If this is set to `true`, metrics (beta) are not accepted by the component.
#[configurable(metadata(docs::advanced))]
#[serde(default = "crate::serde::default_false")]
disable_metrics: bool,

/// If this is set to `true`, traces are not accepted by the component.
/// If this is set to `true`, traces (alpha) are not accepted by the component.
#[configurable(metadata(docs::advanced))]
#[serde(default = "crate::serde::default_false")]
disable_traces: bool,

/// If this is set to `true` logs, metrics, and traces are sent to different outputs.
/// If this is set to `true`, logs, metrics (beta), and traces (alpha) are sent to different outputs.
///
///
/// For a source component named `agent`, the received logs, metrics, and traces can then be
/// For a source component named `agent`, the received logs, metrics (beta), and traces (alpha) can then be
/// configured as input to other components by specifying `agent.logs`, `agent.metrics`, and
/// `agent.traces`, respectively.
#[configurable(metadata(docs::advanced))]
Expand Down
2 changes: 1 addition & 1 deletion src/sources/kafka.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ enum BuildError {
SubscribeError { source: rdkafka::error::KafkaError },
}

/// Metrics configuration.
/// Metrics (beta) configuration.
#[configurable_component]
#[derive(Clone, Debug, Default)]
struct Metrics {
Expand Down
2 changes: 1 addition & 1 deletion src/transforms/aggregate.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ use crate::{
pub struct AggregateConfig {
/// The interval between flushes, in milliseconds.
///
/// During this time frame, metrics with the same series data (name, namespace, tags, and so on) are aggregated.
/// During this time frame, metrics (beta) with the same series data (name, namespace, tags, and so on) are aggregated.
#[serde(default = "default_interval_ms")]
#[configurable(metadata(docs::human_name = "Flush Interval"))]
pub interval_ms: u64,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,12 @@ base: components: sources: datadog_agent: configuration: {
type: bool: default: false
}
disable_metrics: {
description: "If this is set to `true`, metrics are not accepted by the component."
description: "If this is set to `true`, metrics (beta) are not accepted by the component."
required: false
type: bool: default: false
}
disable_traces: {
description: "If this is set to `true`, traces are not accepted by the component."
description: "If this is set to `true`, traces (alpha) are not accepted by the component."
required: false
type: bool: default: false
}
Expand Down Expand Up @@ -276,9 +276,9 @@ base: components: sources: datadog_agent: configuration: {
}
multiple_outputs: {
description: """
If this is set to `true` logs, metrics, and traces are sent to different outputs.
If this is set to `true`, logs, metrics (beta), and traces (alpha) are sent to different outputs.
For a source component named `agent`, the received logs, metrics, and traces can then be
For a source component named `agent`, the received logs, metrics (beta), and traces (alpha) can then be
configured as input to other components by specifying `agent.logs`, `agent.metrics`, and
`agent.traces`, respectively.
"""
Expand Down
2 changes: 1 addition & 1 deletion website/cue/reference/components/sources/base/kafka.cue
Original file line number Diff line number Diff line change
Expand Up @@ -361,7 +361,7 @@ base: components: sources: kafka: configuration: {
}
}
metrics: {
description: "Metrics configuration."
description: "Metrics (beta) configuration."
required: false
type: object: options: topic_lag_metric: {
description: "Expose topic lag metrics for all topics and partitions. Metric names are `kafka_consumer_lag`."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ base: components: transforms: aggregate: configuration: interval_ms: {
description: """
The interval between flushes, in milliseconds.
During this time frame, metrics with the same series data (name, namespace, tags, and so on) are aggregated.
During this time frame, metrics (beta) with the same series data (name, namespace, tags, and so on) are aggregated.
"""
required: false
type: uint: default: 10000
Expand Down

0 comments on commit 8a1ed17

Please sign in to comment.