Skip to content

stats: add prefix to StatsConfig #604

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.

Sign up for GitHub

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

Merged
mattklein123 merged 6 commits into from
Apr 10, 2018
Merged

stats: add prefix to StatsConfig #604

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7c94d79
stats: add prefix to StatsConfig
athampy Apr 4, 2018
0e3e802
stats: Add documentation for prefix
athampy Apr 4, 2018
59efd25
stats: add example for prefix
athampy Apr 9, 2018
085caee
stats: document default prefix
athampy Apr 10, 2018
085b5ed
stats: fix format
athampy Apr 10, 2018
0842511
stats: fix prefix documentation
athampy Apr 10, 2018
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
18 changes: 18 additions & 0 deletions envoy/config/metrics/v2/stats.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,24 @@ message StatsdSink {
// Envoy will connect to this cluster to flush statistics.
string tcp_cluster_name = 2;
}
// [#not-implemented-hide:] Optional custom prefix for StatsdSink. If
// specified, this will override the default prefix.

@mattklein123 mattklein123 Apr 4, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you potentially given an example of how this would be used and what change it will make in the emitted metrics?

@athampy athampy Apr 9, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated.

@mattklein123 mattklein123 Apr 9, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you specify what the default is if not specified? "envoy" ?

@athampy athampy Apr 10, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Done!

// For example:
// .. code-block:: json
// prefix : "envoy-prod"
// will change emitted stats to
// .. code-block:: cpp
// envoy-prod.test_counter:1|c
// envoy-prod.test_timer:5|ms
//
// Note that the default prefix, "envoy", will be used if a prefix is not
// specified.
// Stats with default prefix:
// .. code-block:: cpp
// envoy.test_counter:1|c
// envoy.test_timer:5|ms

@mattklein123 mattklein123 Apr 10, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please view the rendered docs. This blank line makes the docs not attach.

@athampy athampy Apr 10, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Sorry! This is what it looks like now:

string prefix = 3;

@mattklein123 mattklein123 Apr 4, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please add documentation as well as the not-implemented-hide tag until it's implemented. Thanks!

@athampy athampy Apr 4, 2018

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated.

}

// Stats configuration proto schema for built-in *envoy.dog_statsd* sink.
Expand Down