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.

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

docs: Add HTTP port to collector docker command #5441

Merged
merged 7 commits into from
Nov 13, 2024
Merged

docs: Add HTTP port to collector docker command #5441

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2d62a99
docs: Add HTTP port to collector example
kaylareopelle Oct 18, 2024
0b0a0d4
docs: Put port comment above docker run command
kaylareopelle Oct 21, 2024
c9d08a4
chore: Integrate comment into text above
kaylareopelle Nov 5, 2024
838ec1b
Update content/en/docs/collector/quick-start.md
kaylareopelle Nov 5, 2024
c793381
Results from /fix:format
opentelemetrybot Nov 6, 2024
a365e34
Merge branch 'main' into docker-run-4318
tiffany76 Nov 6, 2024
06a69e8
Merge branch 'main' into docker-run-4318
kaylareopelle Nov 12, 2024
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
2 changes: 2 additions & 0 deletions content/en/docs/collector/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,10 @@ preferred shell.
3. Launch the Collector:

```sh
# 4317 for gRPC, 4318 for HTTP, 55679 for ZPages
Copy link
Contributor

Choose a reason for hiding this comment

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

I still feel it better to just drop the comment, but will let other @open-telemetry/docs-approvers chime in. If we keep it, let's be clear that this comment is referring to port numbers.

Copy link
Member

Choose a reason for hiding this comment

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

Can we move that comment into the text above, like "Launch the Collector, listening on ports 4317 (for OTLP grPC), 4318 (for OTLP HTTP) and 55679 (for ZPages):"

Copy link
Contributor Author

@kaylareopelle kaylareopelle Nov 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Either way works for me! I updated the PR to use the text @svrnm suggested in: c9d08a4

docker run \
-p 127.0.0.1:4317:4317 \
-p 127.0.0.1:4318:4318 \
-p 127.0.0.1:55679:55679 \
otel/opentelemetry-collector-contrib:{{% param vers %}} \
2>&1 | tee collector-output.txt # Optionally tee output for easier search later
Expand Down