Skip to content

new: add optional HELP line support #130

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
merged 2 commits into from
Aug 4, 2025
Merged

new: add optional HELP line support #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ea08dd
new: add optional HELP line support
incertum Jul 31, 2025
ddc3cf4
update: reviewers suggestions re optional HELP line support
incertum Aug 1, 2025
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
8 changes: 5 additions & 3 deletions Sources/Prometheus/MetricDescriptor.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ public struct MetricNameDescriptor {
/// An optional suffix describing the metric's unit (e.g., `total`).
public let unitName: String?

/// Optional descriptive text for the metric.
/// Optional help text for the metric. If a non-empty string is provided, it will be emitted as a `# HELP` line in the exposition format.
/// If the parameter is omitted or an empty string is passed, the `# HELP` line will not be generated for this metric.
public let helpText: String?

/// Creates a new ``MetricNameDescriptor`` that defines the components of a fully qualified Prometheus metric name.
Expand All @@ -39,7 +40,8 @@ public struct MetricNameDescriptor {
/// - Parameter subsystem: An optional subsystem to group related metrics within a namespace.
/// - Parameter metricName: The required, descriptive base name of the metric.
/// - Parameter unitName: An optional suffix describing the metric's unit (e.g., `total`).
/// - Parameter helpText: Optional descriptive text for the metric.
/// - Parameter helpText: Optional help text for the metric. If a non-empty string is provided, it will be emitted as a `# HELP` line in the exposition format.
/// If the parameter is omitted or an empty string is passed, the `# HELP` line will not be generated for this metric.
public init(
namespace: String? = nil,
subsystem: String? = nil,
Expand All @@ -55,7 +57,7 @@ public struct MetricNameDescriptor {
self.helpText = helpText
}

/// The fully qualified metric name, joining non-empty components with underscores.
/// The fully qualified metric name, joining non-empty components with underscores (e.g. `namespace_subsytem_metricName_unitName`).
public var name: String {
[namespace, subsystem, metricName, unitName]
.compactMap { $0?.isEmpty == false ? $0 : nil }
Expand Down
Loading