From nobody Fri Sep 04 18:49:10 2026 X-Original-To: dev-commits-src-branches@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4hc5931nZmz6r5bV for ; Fri, 04 Sep 2026 18:49:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "YR2" (not verified)) by mx1.freebsd.org (Postfix) with ESMTPS id 4hc5926whcz3Bmm for ; Fri, 04 Sep 2026 18:49:10 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1788547751; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=dLwpy61AKL0jVvtKavLuwBGY15ZB4L1gbbSMY06GH8A=; b=Ad1t+DU/AbYDOUX8uF6P/H5h82zgyzsRHu+q/fOfj0ZUlshgNYXEGz+mIXzVCrWHPJrWg3 +gB4+r/N8bGeI7WbsM5wnRG4z/ixFf3TpC5aXvTxBZYtMczWimw3Hhe2m/E//oKYRptpAr Y7twZaAWMeBqaOLDTySVhAyzY300q8u4XAm8H8qToKViZ7nXjkys1oKxhoUqo/jdKpJh2X vLDvJIDc0GGTMw+ZZDnxOVzXtjW8TYQgjtR+okXBEqcL9rNhnVna2zpFHMNFZL1iRfiEPY 9gya2O/NEYwaOCWkUaKwM/S/sgk9IEl/0bxUATBvbQlQFeWjvBPiO77bTCJw1Q== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1788547751; a=rsa-sha256; cv=none; b=OuQSIuaagyKj2ufWpdiGbljF7RvFVzZbrc9d05IcYs2pZ26L/ziMX14LAglLxnCjPGkfq/ Rel5WokLxWPzI/aQ2O6ojzLyJR8XTf39KYRCIST+zfrKeE18XzUpYUG6dQHGuAgqE46/vK gFdhOxaWhLdSaqxEEZVtuPnIgVPsjm8ohKgK+wYPCZD8FWXYBfiQnuQSapD6ptxeglLajJ scmC8kCif4LpNCrQ/CCzlGhN+who9NPaKdIVo2PDVGeqiyFwOSsg2PgiltfQZ3RxViYdOW owgbp19aK2Dr7C67uy+vBUn7LhJuc+bdiLKzEAfo5I6r+pDE9sAaFtgYrz31oA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1788547751; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=dLwpy61AKL0jVvtKavLuwBGY15ZB4L1gbbSMY06GH8A=; b=pq6ds0gUrItl2kSQI7mz+XXiVGy6HXDF9R7dvzoVPdiLmLgQ/l5iQehPEgWYucSzIoWIwV aqdtRJ6dJHXIDAxByjgUCroY9pDpStB5FOlVzfBj3NSPkAcxC7ZfS/13cEYlIAyngu622j 5t5cXlmaepHSU1I0jd59YYI5xK7z85T5yXa4vuDVNcC7JmFoxmUxs3if5apJjyPKWe4R2b eY4uOs2P3zS8dFLNy6rE/UbmntecAlAlQQVuRg4tt3UjQ6Iha3Ejcq72SRHgjorcLamzd7 DNo5Bisjusv53DbsmVQF+t5uJUt7IdEDSAuMke1Ffgfstk0Ysh716nP3GETgnw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) by mxrelay.nyi.freebsd.org (Postfix) with ESMTP id 4hc5925SJCz1B9h for ; Fri, 04 Sep 2026 18:49:10 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from git (uid 1279) (envelope-from git@FreeBSD.org) id 1fbda by gitrepo.freebsd.org (DragonFly Mail Agent v0.13+ on gitrepo.freebsd.org); Fri, 04 Sep 2026 18:49:10 +0000 To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Kyle Evans Subject: git: 8d227fc5ddf9 - stable/15 - prometheus_sysctl_exporter: don't abort on bad labels List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-branches@freebsd.org Sender: owner-dev-commits-src-branches@FreeBSD.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: kevans X-Git-Repository: src X-Git-Refname: refs/heads/stable/15 X-Git-Reftype: branch X-Git-Commit: 8d227fc5ddf95a6f7f270779ae45f5943db6ad56 Auto-Submitted: auto-generated Date: Fri, 04 Sep 2026 18:49:10 +0000 Message-Id: <6a9b12a6.1fbda.2917da6e@gitrepo.freebsd.org> The branch stable/15 has been updated by kevans: URL: https://cgit.FreeBSD.org/src/commit/?id=8d227fc5ddf95a6f7f270779ae45f5943db6ad56 commit 8d227fc5ddf95a6f7f270779ae45f5943db6ad56 Author: Kyle Evans AuthorDate: 2026-08-07 01:54:04 +0000 Commit: Kyle Evans CommitDate: 2026-09-04 15:32:39 +0000 prometheus_sysctl_exporter: don't abort on bad labels We can probaby consider these kernel bugs, in which case asserting is not the most helpful thing we can do. Let's emit the necessary details to stderr and exit non-zero to aid debugging these without completely blocking the ability to export all of the well-formed metrics. Reviewed by: rew (cherry picked from commit 4f42ec2f38ee4a4eba8f3298e7968f0523f87aa0) --- .../prometheus_sysctl_exporter.8 | 7 ++- .../prometheus_sysctl_exporter.c | 54 ++++++++++++++++------ 2 files changed, 46 insertions(+), 15 deletions(-) diff --git a/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.8 b/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.8 index da09f43c1cf9..57e29cdd5b86 100644 --- a/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.8 +++ b/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.8 @@ -20,7 +20,7 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.Dd October 7, 2021 +.Dd August 6, 2026 .Dt PROMETHEUS_SYSCTL_EXPORTER 8 .Os .Sh NAME @@ -95,6 +95,11 @@ is to be a regular expression as described in The provided regular expression is tested against the Prometheus metric name. .El +.Sh EXIT STATUS +The +.Nm +utility exits 0 on success, and >0 if an error is encountered while processing +metric labels. .Sh SEE ALSO .Xr cron 8 , .Xr inetd 8 , diff --git a/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.c b/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.c index e3182467beab..b384df8da22e 100644 --- a/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.c +++ b/usr.sbin/prometheus_sysctl_exporter/prometheus_sysctl_exporter.c @@ -371,8 +371,14 @@ oid_get_name(const struct oid *o, struct oidname *on) on->oid = *o; } -/* Populates the name and labels of an OID to a buffer. */ -static void +/* + * Populates the name and labels of an OID to a buffer. If an invalid label is + * encountered, we'll skip the metric entirely to avoid outputting ambiguous + * metrics and emit the relevant details to stderr for correction. + * + * Returns true if the metric is valid, false otherwise. + */ +static bool oid_get_metric(const struct oidname *on, const struct oidformat *of, char *metric, size_t mlen) { @@ -409,10 +415,15 @@ oid_get_metric(const struct oidname *on, const struct oidformat *of, separator = '{'; for (i = 0; i < on->oid.len; ++i) { if (*label != '\0') { - assert(label[strspn(label, + if (label[strspn(label, "abcdefghijklmnopqrstuvwxyz" "ABCDEFGHIJKLMNOPQRSTUVWXYZ" - "0123456789_")] == '\0'); + "0123456789_")] != '\0') { + warnx("bad label for metric '%s': %s", + metric, label); + return (false); + } + snprintf(buf, sizeof(buf), "%c%s=\"", separator, label); strlcat(metric, buf, mlen); while (*name != '\0') { @@ -430,6 +441,8 @@ oid_get_metric(const struct oidname *on, const struct oidformat *of, } if (separator != '{') strlcat(metric, "}", mlen); + + return (true); } /* Returns whether the OID name has any labels associated to it. */ @@ -486,7 +499,14 @@ oiddescription_print(const struct oiddescription *od, FILE *fp) fprintf(fp, "%s", od->description); } -static void +/* + * Print the given oid, subject to include/exclude rules. Returns true if the + * oid was skipped or printed, false if an error was encountered. + * + * For the purposes of the exporter, we don't consider it an error to be unable + * to fetch format/value information. + */ +static bool oid_print(const struct oid *o, struct oidname *on, bool print_description, bool exclude, bool include, FILE *fp) { @@ -497,16 +517,17 @@ oid_print(const struct oid *o, struct oidname *on, bool print_description, bool has_desc; if (!oid_get_format(o, &of) || !oid_get_value(o, &of, &ov)) - return; + return (true); oid_get_name(o, on); - oid_get_metric(on, &of, metric, sizeof(metric)); + if (!oid_get_metric(on, &of, metric, sizeof(metric))) + return (false); if (exclude && regexec(&exc_regex, metric, 0, NULL, 0) == 0) - return; + return (true); if (include && regexec(&inc_regex, metric, 0, NULL, 0) != 0) - return; + return (true); has_desc = oid_get_description(o, &od); /* @@ -514,7 +535,7 @@ oid_print(const struct oid *o, struct oidname *on, bool print_description, * redundant ZFS sysctls whose names alias with the non-legacy versions. */ if (has_desc && strnstr(od.description, "(LEGACY)", BUFSIZ) != NULL) - return; + return (true); /* * Print the line with the description. Prometheus expects a * single unique description for every metric, which cannot be @@ -534,6 +555,7 @@ oid_print(const struct oid *o, struct oidname *on, bool print_description, fputc(' ', fp); oidvalue_print(&ov, fp); fputc('\n', fp); + return (true); } /* Gzip compresses a buffer of memory. */ @@ -573,7 +595,7 @@ main(int argc, char *argv[]) char *http_buf; FILE *fp; size_t http_buflen; - int ch, error; + int ch, error, failed = 0; bool exclude, include, gzip_mode, http_mode, print_descriptions; char errbuf[BUFSIZ]; @@ -631,7 +653,9 @@ main(int argc, char *argv[]) /* Print all OIDs. */ oid_get_root(&o); do { - oid_print(&o, &on, print_descriptions, exclude, include, fp); + if (!oid_print(&o, &on, print_descriptions, exclude, + include, fp)) + failed++; } while (oid_get_next(&o, &o)); } else { int i; @@ -651,7 +675,9 @@ main(int argc, char *argv[]) } o = root; do { - oid_print(&o, &on, print_descriptions, exclude, include, fp); + if (!oid_print(&o, &on, print_descriptions, + exclude, include, fp)) + failed++; } while (oid_get_next(&o, &o) && oid_is_beneath(&o, &root)); } @@ -702,5 +728,5 @@ main(int argc, char *argv[]) } } } - return (0); + return (failed != 0 ? 1 : 0); }