Skip to content

docs: use test example to document prometheus.InstallNewPipeline #1796

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
MrAlias merged 6 commits into from
Apr 13, 2021
Merged

docs: use test example to document prometheus.InstallNewPipeline #1796

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
72d91d2
docs: update InstallNewPipeline example comment
slagiewka Apr 12, 2021
3c7c0ed
docs: update changelog after PR submit
slagiewka Apr 12, 2021
f4eda32
fix: wrap issue number in parens
slagiewka Apr 12, 2021
3759275
docs: use test example to document prometheus.InstallNewPipeline
slagiewka Apr 13, 2021
5cc81cd
fix: update CHANGELOG to reflect PR state
slagiewka Apr 13, 2021
a89fc34
Merge branch 'main' into docs_install_new_pipeline
MrAlias Apr 13, 2021
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
It no longer is a conglomerate of itself, events, and link attributes that have been dropped. (#1771)
- Make `ExportSpans` in Jaeger Exporter honor context deadline. (#1773)
- The `go.opentelemetry.io/otel/sdk/export/trace` package is merged into the `go.opentelemetry.io/otel/sdk/trace` package. (#1778)
- Updated InstallNewPipeline example comment (#1796)

### Removed

Expand Down
6 changes: 3 additions & 3 deletions exporters/metric/prometheus/prometheus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,13 +130,13 @@ func NewExportPipeline(config Config, options ...controller.Option) (*Exporter,
// InstallNewPipeline instantiates a NewExportPipeline and registers it globally.
// Typically called as:
//
// hf, err := prometheus.InstallNewPipeline(prometheus.Config{...})
// exporter, err := prometheus.InstallNewPipeline(prometheus.Config{...})
//
// if err != nil {
// ...
// }
// http.HandleFunc("/metrics", hf)
// defer pipeline.Stop()
// http.HandleFunc("/metrics", exporter)
// defer exporter.Controller().Stop(context.TODO())
// ... Done
func InstallNewPipeline(config Config, options ...controller.Option) (*Exporter, error) {
exp, err := NewExportPipeline(config, options...)
Expand Down