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

[docs] Improve pipeline section docs #6176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

PadreSVK
Copy link

@PadreSVK PadreSVK commented Feb 2, 2025

@PadreSVK PadreSVK requested a review from a team as a code owner February 2, 2025 18:23
Copy link

linux-foundation-easycla bot commented Feb 2, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: PadreSVK / name: Patrik Švikruha (ec7c3d1)

@opentelemetrybot opentelemetrybot requested review from a team and mx-psi and removed request for a team February 2, 2025 18:23
Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

Thank you! Left one comment, I am not a technical writer so it may be that others have a better suggestion here

Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

Beyond the suggested change from @mx-psi this looks good to me. If you can fix that, we can merge it in

@opentelemetrybot opentelemetrybot requested review from a team and bogdandrutu and removed request for a team February 6, 2025 14:14
@@ -627,6 +627,24 @@ service:
processors: [batch, memory_limiter]
exporters: [opencensus, zipkin]
```
As with components, use the `type[/name]` syntax to create additional pipelines for a given type.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
As with components, use the `type[/name]` syntax to create additional pipelines for a given type.
As with components, use the `type[/name]` syntax to create additional pipelines for a given type. Here is an example extending the previous configuration:

Comment on lines +632 to +647
```yaml
service:
pipelines:
metrics:
receivers: [opencensus, prometheus]
processors: [batch]
exporters: [opencensus, prometheus]
traces:
receivers: [opencensus, jaeger]
processors: [batch, memory_limiter]
exporters: [opencensus, zipkin]
traces/better_pipeline:
receivers: [opencensus]
processors: [batch]
exporters: [zipkin]
```
Copy link
Contributor

Choose a reason for hiding this comment

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

How about this so that we can keep the focus on what was added?

Suggested change
```yaml
service:
pipelines:
metrics:
receivers: [opencensus, prometheus]
processors: [batch]
exporters: [opencensus, prometheus]
traces:
receivers: [opencensus, jaeger]
processors: [batch, memory_limiter]
exporters: [opencensus, zipkin]
traces/better_pipeline:
receivers: [opencensus]
processors: [batch]
exporters: [zipkin]
```
```yaml
service:
pipelines:
# ...
traces:
# ...
traces/better_pipeline:
receivers: [opencensus]
processors: [batch]
exporters: [zipkin]
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, is there an alternative name to /better_pipeline that we can use? Previous examples in the page use /2.

@tiffany76
Copy link
Contributor

Hi @PadreSVK, please take a look at the most recent suggested changes so we can move this PR forward. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants