-
Notifications
You must be signed in to change notification settings - Fork 4.4k
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
Rename hcp-metrics-collector to consul-telemetry-collector #17327
Conversation
384da30
to
1e08e3d
Compare
@@ -190,6 +190,10 @@ the [`sidecar_service`](/consul/docs/connect/registration/sidecar-service) block | |||
- `envoy_stats_flush_interval` - Configures Envoy's | |||
[`stats_flush_interval`](https://www.envoyproxy.io/docs/envoy/v1.17.2/api-v3/config/bootstrap/v3/bootstrap.proto#envoy-v3-api-field-config-bootstrap-v3-bootstrap-stats-flush-interval). | |||
|
|||
- `envoy_telemetry_collector_bind_socket_dir` - Specifies the directory where Envoy creates a unix socket. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should have been the right place to have the docs, so the docs were moved from website/content/commands/connect/envoy.mdx
to this file.
154e708
to
df88393
Compare
df88393
to
a98ea8b
Compare
a98ea8b
to
e86acde
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor suggestions for the docs.
- `envoy_telemetry_collector_bind_socket_dir` - Specifies the directory where Envoy creates a unix socket. | ||
Envoy sends metrics to the socket with which a consul telemetry collector can collect them. | ||
The socket is not configured by default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- `envoy_telemetry_collector_bind_socket_dir` - Specifies the directory where Envoy creates a unix socket. | |
Envoy sends metrics to the socket with which a consul telemetry collector can collect them. | |
The socket is not configured by default. | |
- `envoy_telemetry_collector_bind_socket_dir` - Specifies the directory where Envoy creates a Unix socket. | |
Envoy sends metrics to the socket where a Consul telemetry collector can collect them. | |
The socket is not configured by default. |
If I'm not mistaken, Unix is a proper noun.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
You are re-naming everything and nothing is jumping out at me.
* Rename hcp-metrics-collector to consul-telemetry-collector * Fix docs * Fix doc comment --------- Co-authored-by: Ashvitha Sridharan <[email protected]>
…17412) * Rename hcp-metrics-collector to consul-telemetry-collector * Fix docs * Fix doc comment --------- Co-authored-by: Connor <[email protected]>
Description
We originally named the collector service name as hcp-metrics-collector. Rename the service name to follow the intended project name.
Also renamed the
bind_socket_dir
config key to remove thehcp
reference. The collector can be used without HCP so it made sense to generalize the nameTesting & Reproduction steps
bin/consul agent -dev
consul services register web.json
}```
consul services register collector.json
./bin/consul connect envoy -sidecar-for web -- -l debug
./bin/consul connect envoy -admin-bind localhost:19001 -sidecar-for consul-telemetry-collector -- -l debug
Links
PR Checklist