Rename hcp-metrics-collector to consul-telemetry-collector#17327
Merged
Conversation
Achooo
reviewed
May 12, 2023
freddygv
reviewed
May 12, 2023
384da30 to
1e08e3d
Compare
jjti
suggested changes
May 15, 2023
Achooo
reviewed
May 15, 2023
Contributor
There was a problem hiding this comment.
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
jjti
reviewed
May 15, 2023
df88393 to
a98ea8b
Compare
a98ea8b to
e86acde
Compare
Contributor
trujillo-adam
left a comment
There was a problem hiding this comment.
Minor suggestions for the docs.
Comment on lines
+193
to
+195
| - `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. |
Contributor
There was a problem hiding this comment.
Suggested change
| - `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.
curtbushko
approved these changes
May 16, 2023
Contributor
curtbushko
left a comment
There was a problem hiding this comment.
LGTM!
You are re-naming everything and nothing is jumping out at me.
jjti
approved these changes
May 16, 2023
Closed
4 tasks
Achooo
added a commit
that referenced
this pull request
May 18, 2023
* Rename hcp-metrics-collector to consul-telemetry-collector * Fix docs * Fix doc comment --------- Co-authored-by: Ashvitha Sridharan <ashvitha.sridharan@hashicorp.com>
4 tasks
Achooo
added a commit
that referenced
this pull request
May 19, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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_dirconfig key to remove thehcpreference. The collector can be used without HCP so it made sense to generalize the nameTesting & Reproduction steps
bin/consul agent -devconsul services register web.json{ "service": { "name": "web", "port": 9191, "connect": { "sidecar_service": { "proxy": { "config": { "envoy_telemetry_collector_bind_socket_dir": "/Users/ashvitha.sridharan/tmp/" } } } } }}```
consul services register collector.json{ "service":{ "name": "consul-telemetry-collector", "port": 9090, "connect": { "sidecar_service": { } } } }./bin/consul connect envoy -sidecar-for web -- -l debug./bin/consul connect envoy -admin-bind localhost:19001 -sidecar-for consul-telemetry-collector -- -l debugLinks
PR Checklist