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

Fix/prometheusexporter Shutdown HTTP server #35465

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
27 changes: 27 additions & 0 deletions .chloggen/fix_prometheusexporter-shutdown-server.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.
dashpole marked this conversation as resolved.
Show resolved Hide resolved

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: prometheusexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Fixes an issue where the prometheus exporter would not shut down the server when the collector was stopped."

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [35464]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
15 changes: 9 additions & 6 deletions exporter/prometheusexporter/prometheus.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ type prometheusExporter struct {
config Config
name string
endpoint string
shutdownFunc func() error
shutdownFunc func(ctx context.Context) error
handler http.Handler
collector *collector
registry *prometheus.Registry
Expand All @@ -44,7 +44,7 @@ func newPrometheusExporter(config *Config, set exporter.Settings) (*prometheusEx
endpoint: addr,
collector: collector,
registry: registry,
shutdownFunc: func() error { return nil },
shutdownFunc: func(_ context.Context) error { return nil },
handler: promhttp.HandlerFor(
registry,
promhttp.HandlerOpts{
Expand All @@ -63,11 +63,14 @@ func (pe *prometheusExporter) Start(ctx context.Context, host component.Host) er
return err
}

pe.shutdownFunc = ln.Close

mux := http.NewServeMux()
mux.Handle("/metrics", pe.handler)
srv, err := pe.config.ToServer(ctx, host, pe.settings, mux)
pe.shutdownFunc = func(ctx context.Context) error {
err := ln.Close()
dashpole marked this conversation as resolved.
Show resolved Hide resolved
err2 := srv.Shutdown(ctx)
dashpole marked this conversation as resolved.
Show resolved Hide resolved
return errors.Join(err, err2)
}
if err != nil {
return err
}
Expand All @@ -88,6 +91,6 @@ func (pe *prometheusExporter) ConsumeMetrics(_ context.Context, md pmetric.Metri
return nil
}

func (pe *prometheusExporter) Shutdown(context.Context) error {
return pe.shutdownFunc()
func (pe *prometheusExporter) Shutdown(ctx context.Context) error {
return pe.shutdownFunc(ctx)
dashpole marked this conversation as resolved.
Show resolved Hide resolved
}
Loading