Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(observability): issues with event_cache PR #17768

Merged
merged 3 commits into from
Jun 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion lib/vector-common/src/request_metadata.rs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ impl EventCountTags {
service: OptionalTag::Specified(None),
}
}

#[must_use]
pub fn new_unspecified() -> Self {
Self {
source: OptionalTag::Ignored,
service: OptionalTag::Ignored,
}
}
}

/// Must be implemented by events to get the tags that will be attached to
Expand Down Expand Up @@ -133,7 +141,7 @@ impl GroupedCountByteSize {
}
}
GroupedCountByteSize::Untagged { size } => {
event_cache.emit(&EventCountTags::new_empty(), *size);
event_cache.emit(&EventCountTags::new_unspecified(), *size);
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion lib/vector-core/src/event/log_event.rs
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ impl GetEventCountTags for LogEvent {

let service = if telemetry().tags().emit_service {
self.get_by_meaning("service")
.map(ToString::to_string)
.map(|value| value.to_string_lossy().to_string())
.into()
} else {
OptionalTag::Ignored
Expand Down
56 changes: 56 additions & 0 deletions website/cue/reference/configuration.cue
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,62 @@ configuration: {
}
}

telemetry: {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I take it that this is not generated from the configurable trait? Maybe that doesn't work for global options?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I'm pretty sure it only works for components.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀 but global options are marked with configurable?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc/ @tobz to confirm. Maybe it just isn't handled by the Ruby script that turns the JSON schema into cue docs yet.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no reference/base to include them in the cue file from..

common: false
description: """
Configures options for how Vector emits telemetry.
"""
required: false
type: object: {
examples: []
options: {
tags: {
required: false
description: """
Controls which tags should be included with the `vector_component_sent_events_total` and
`vector_component_sent_event_bytes_total` metrics.
"""
type: object: {
examples: []
options: {
emit_source: {
common: true
description: """
Add a `source` tag with the source component the event was received from.

If there is no source component, for example if the event was generated by
the `lua` transform a `-` is emitted for this tag.
"""
required: false
type: bool: {
default: false
}
}
emit_service: {
common: false
description: """
Adds a `service` tag with the service component the event was received from.

For logs this is the field that has been determined to mean `service`. Each source may
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs for this section should be updated with a link to the section about meanings when that section exists.

define different fields for this. For example, with `syslog` events the `appname` field
is used.

Metric events will use the tag named `service`.

If no service is available a `-` is emitted for this tag.
"""
required: false
type: bool: {
default: false
}
}
}
}
}
}
}
}

log_schema: {
common: false
description: """
Expand Down