- tor-commits - lists.torproject.org

[tor/main] hs: Double quote the metrics label value
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit 3c73622f27c67eb636f19a938c5f401da8db901f Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Feb 2 13:51:22 2022 -0500 hs: Double quote the metrics label value Fixes #40552 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/changes/ticket40552 b/changes/ticket40552 new file mode 100644 index 0000000000..7811f3a743 --- /dev/null +++ b/changes/ticket40552 @@ -0,0 +1,3 @@ + o Minor bugfixes (MetricsPort, Prometheus): + - Add double quotes to the label values of the onion service metrics. Fixes + bug 40552; bugfix on 0.4.5.1-alpha. diff --git a/src/feature/hs/hs_metrics.c b/src/feature/hs/hs_metrics.c index e6d3084f26..452bb44419 100644 --- a/src/feature/hs/hs_metrics.c +++ b/src/feature/hs/hs_metrics.c @@ -32,12 +32,16 @@ port_to_str(const uint16_t port) /** Return a static buffer pointer that contains a formatted label on the form * of key=value. * + * NOTE: Important, label values MUST NOT contain double quotes else, in the + * case of Prometheus, it will fail with a malformed line because we force the + * label value to be enclosed in double quotes. + * * Subsequent call to this function invalidates the previous buffer. */ static const char * format_label(const char *key, const char *value) { static char buf[128]; - tor_snprintf(buf, sizeof(buf), "%s=%s", key, value); + tor_snprintf(buf, sizeof(buf), "%s=\"%s\"", key, value); return buf; } diff --git a/src/test/test_metrics.c b/src/test/test_metrics.c index 152dd99d23..58628e8483 100644 --- a/src/test/test_metrics.c +++ b/src/test/test_metrics.c @@ -30,8 +30,8 @@ #define TEST_METRICS_ENTRY_NAME "entryA" #define TEST_METRICS_ENTRY_HELP "Description of entryA" -#define TEST_METRICS_ENTRY_LABEL_1 "label=farfadet" -#define TEST_METRICS_ENTRY_LABEL_2 "label=ponki" +#define TEST_METRICS_ENTRY_LABEL_1 "label=\"farfadet\"" +#define TEST_METRICS_ENTRY_LABEL_2 "label=\"ponki\"" static void set_metrics_port(or_options_t *options)

1 0

[tor/maint-0.4.5] hs: Double quote the metrics label value
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit 3c73622f27c67eb636f19a938c5f401da8db901f Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Feb 2 13:51:22 2022 -0500 hs: Double quote the metrics label value Fixes #40552 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/changes/ticket40552 b/changes/ticket40552 new file mode 100644 index 0000000000..7811f3a743 --- /dev/null +++ b/changes/ticket40552 @@ -0,0 +1,3 @@ + o Minor bugfixes (MetricsPort, Prometheus): + - Add double quotes to the label values of the onion service metrics. Fixes + bug 40552; bugfix on 0.4.5.1-alpha. diff --git a/src/feature/hs/hs_metrics.c b/src/feature/hs/hs_metrics.c index e6d3084f26..452bb44419 100644 --- a/src/feature/hs/hs_metrics.c +++ b/src/feature/hs/hs_metrics.c @@ -32,12 +32,16 @@ port_to_str(const uint16_t port) /** Return a static buffer pointer that contains a formatted label on the form * of key=value. * + * NOTE: Important, label values MUST NOT contain double quotes else, in the + * case of Prometheus, it will fail with a malformed line because we force the + * label value to be enclosed in double quotes. + * * Subsequent call to this function invalidates the previous buffer. */ static const char * format_label(const char *key, const char *value) { static char buf[128]; - tor_snprintf(buf, sizeof(buf), "%s=%s", key, value); + tor_snprintf(buf, sizeof(buf), "%s=\"%s\"", key, value); return buf; } diff --git a/src/test/test_metrics.c b/src/test/test_metrics.c index 152dd99d23..58628e8483 100644 --- a/src/test/test_metrics.c +++ b/src/test/test_metrics.c @@ -30,8 +30,8 @@ #define TEST_METRICS_ENTRY_NAME "entryA" #define TEST_METRICS_ENTRY_HELP "Description of entryA" -#define TEST_METRICS_ENTRY_LABEL_1 "label=farfadet" -#define TEST_METRICS_ENTRY_LABEL_2 "label=ponki" +#define TEST_METRICS_ENTRY_LABEL_1 "label=\"farfadet\"" +#define TEST_METRICS_ENTRY_LABEL_2 "label=\"ponki\"" static void set_metrics_port(or_options_t *options)

1 0

[tor/main] Merge branch 'maint-0.4.5' into maint-0.4.6
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit a08b12568eb7f1d1fb8bd34847461e0887b6981d Merge: bc500804fd 3c73622f27 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 3 08:30:40 2022 -0500 Merge branch 'maint-0.4.5' into maint-0.4.6 changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-)

1 0

[tor/main] Merge branch 'maint-0.4.6'
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit 6b06803e0d07a0e2f85dd405a27d2b4d85ef6879 Merge: b6ec7fad0e a08b12568e Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 3 08:30:59 2022 -0500 Merge branch 'maint-0.4.6' changes/ticket40552 | 3 +++ src/test/test_metrics.c | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-)

1 0

[tor/main] changes: Remove uneeded file due to empty merge forward
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit d6f643e4dd69ae4e5f85268055d61d54d2a2eb38 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 3 08:31:49 2022 -0500 changes: Remove uneeded file due to empty merge forward Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40552 | 3 --- 1 file changed, 3 deletions(-) diff --git a/changes/ticket40552 b/changes/ticket40552 deleted file mode 100644 index 7811f3a743..0000000000 --- a/changes/ticket40552 +++ /dev/null @@ -1,3 +0,0 @@ - o Minor bugfixes (MetricsPort, Prometheus): - - Add double quotes to the label values of the onion service metrics. Fixes - bug 40552; bugfix on 0.4.5.1-alpha.

1 0

[tor/maint-0.4.6] Merge branch 'maint-0.4.5' into maint-0.4.6
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit a08b12568eb7f1d1fb8bd34847461e0887b6981d Merge: bc500804fd 3c73622f27 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 3 08:30:40 2022 -0500 Merge branch 'maint-0.4.5' into maint-0.4.6 changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-)

1 0

[tor/release-0.4.5] Merge branch 'maint-0.4.5' into release-0.4.5
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit c2452da6adb7ef6bd401e59ae50cbdfd3fffe562 Merge: 2c9a371666 3c73622f27 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Feb 3 08:30:40 2022 -0500 Merge branch 'maint-0.4.5' into release-0.4.5 changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-)

1 0

[tor/maint-0.4.6] hs: Double quote the metrics label value
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit 3c73622f27c67eb636f19a938c5f401da8db901f Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Feb 2 13:51:22 2022 -0500 hs: Double quote the metrics label value Fixes #40552 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/changes/ticket40552 b/changes/ticket40552 new file mode 100644 index 0000000000..7811f3a743 --- /dev/null +++ b/changes/ticket40552 @@ -0,0 +1,3 @@ + o Minor bugfixes (MetricsPort, Prometheus): + - Add double quotes to the label values of the onion service metrics. Fixes + bug 40552; bugfix on 0.4.5.1-alpha. diff --git a/src/feature/hs/hs_metrics.c b/src/feature/hs/hs_metrics.c index e6d3084f26..452bb44419 100644 --- a/src/feature/hs/hs_metrics.c +++ b/src/feature/hs/hs_metrics.c @@ -32,12 +32,16 @@ port_to_str(const uint16_t port) /** Return a static buffer pointer that contains a formatted label on the form * of key=value. * + * NOTE: Important, label values MUST NOT contain double quotes else, in the + * case of Prometheus, it will fail with a malformed line because we force the + * label value to be enclosed in double quotes. + * * Subsequent call to this function invalidates the previous buffer. */ static const char * format_label(const char *key, const char *value) { static char buf[128]; - tor_snprintf(buf, sizeof(buf), "%s=%s", key, value); + tor_snprintf(buf, sizeof(buf), "%s=\"%s\"", key, value); return buf; } diff --git a/src/test/test_metrics.c b/src/test/test_metrics.c index 152dd99d23..58628e8483 100644 --- a/src/test/test_metrics.c +++ b/src/test/test_metrics.c @@ -30,8 +30,8 @@ #define TEST_METRICS_ENTRY_NAME "entryA" #define TEST_METRICS_ENTRY_HELP "Description of entryA" -#define TEST_METRICS_ENTRY_LABEL_1 "label=farfadet" -#define TEST_METRICS_ENTRY_LABEL_2 "label=ponki" +#define TEST_METRICS_ENTRY_LABEL_1 "label=\"farfadet\"" +#define TEST_METRICS_ENTRY_LABEL_2 "label=\"ponki\"" static void set_metrics_port(or_options_t *options)

1 0

[tor/release-0.4.5] hs: Double quote the metrics label value
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit 3c73622f27c67eb636f19a938c5f401da8db901f Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Feb 2 13:51:22 2022 -0500 hs: Double quote the metrics label value Fixes #40552 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/changes/ticket40552 b/changes/ticket40552 new file mode 100644 index 0000000000..7811f3a743 --- /dev/null +++ b/changes/ticket40552 @@ -0,0 +1,3 @@ + o Minor bugfixes (MetricsPort, Prometheus): + - Add double quotes to the label values of the onion service metrics. Fixes + bug 40552; bugfix on 0.4.5.1-alpha. diff --git a/src/feature/hs/hs_metrics.c b/src/feature/hs/hs_metrics.c index e6d3084f26..452bb44419 100644 --- a/src/feature/hs/hs_metrics.c +++ b/src/feature/hs/hs_metrics.c @@ -32,12 +32,16 @@ port_to_str(const uint16_t port) /** Return a static buffer pointer that contains a formatted label on the form * of key=value. * + * NOTE: Important, label values MUST NOT contain double quotes else, in the + * case of Prometheus, it will fail with a malformed line because we force the + * label value to be enclosed in double quotes. + * * Subsequent call to this function invalidates the previous buffer. */ static const char * format_label(const char *key, const char *value) { static char buf[128]; - tor_snprintf(buf, sizeof(buf), "%s=%s", key, value); + tor_snprintf(buf, sizeof(buf), "%s=\"%s\"", key, value); return buf; } diff --git a/src/test/test_metrics.c b/src/test/test_metrics.c index 152dd99d23..58628e8483 100644 --- a/src/test/test_metrics.c +++ b/src/test/test_metrics.c @@ -30,8 +30,8 @@ #define TEST_METRICS_ENTRY_NAME "entryA" #define TEST_METRICS_ENTRY_HELP "Description of entryA" -#define TEST_METRICS_ENTRY_LABEL_1 "label=farfadet" -#define TEST_METRICS_ENTRY_LABEL_2 "label=ponki" +#define TEST_METRICS_ENTRY_LABEL_1 "label=\"farfadet\"" +#define TEST_METRICS_ENTRY_LABEL_2 "label=\"ponki\"" static void set_metrics_port(or_options_t *options)

1 0

[tor/release-0.4.6] hs: Double quote the metrics label value
by dgoulet＠torproject.org 03 Feb '22

03 Feb '22

commit 3c73622f27c67eb636f19a938c5f401da8db901f Author: David Goulet <dgoulet(a)torproject.org> Date: Wed Feb 2 13:51:22 2022 -0500 hs: Double quote the metrics label value Fixes #40552 Signed-off-by: David Goulet <dgoulet(a)torproject.org> --- changes/ticket40552 | 3 +++ src/feature/hs/hs_metrics.c | 6 +++++- src/test/test_metrics.c | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/changes/ticket40552 b/changes/ticket40552 new file mode 100644 index 0000000000..7811f3a743 --- /dev/null +++ b/changes/ticket40552 @@ -0,0 +1,3 @@ + o Minor bugfixes (MetricsPort, Prometheus): + - Add double quotes to the label values of the onion service metrics. Fixes + bug 40552; bugfix on 0.4.5.1-alpha. diff --git a/src/feature/hs/hs_metrics.c b/src/feature/hs/hs_metrics.c index e6d3084f26..452bb44419 100644 --- a/src/feature/hs/hs_metrics.c +++ b/src/feature/hs/hs_metrics.c @@ -32,12 +32,16 @@ port_to_str(const uint16_t port) /** Return a static buffer pointer that contains a formatted label on the form * of key=value. * + * NOTE: Important, label values MUST NOT contain double quotes else, in the + * case of Prometheus, it will fail with a malformed line because we force the + * label value to be enclosed in double quotes. + * * Subsequent call to this function invalidates the previous buffer. */ static const char * format_label(const char *key, const char *value) { static char buf[128]; - tor_snprintf(buf, sizeof(buf), "%s=%s", key, value); + tor_snprintf(buf, sizeof(buf), "%s=\"%s\"", key, value); return buf; } diff --git a/src/test/test_metrics.c b/src/test/test_metrics.c index 152dd99d23..58628e8483 100644 --- a/src/test/test_metrics.c +++ b/src/test/test_metrics.c @@ -30,8 +30,8 @@ #define TEST_METRICS_ENTRY_NAME "entryA" #define TEST_METRICS_ENTRY_HELP "Description of entryA" -#define TEST_METRICS_ENTRY_LABEL_1 "label=farfadet" -#define TEST_METRICS_ENTRY_LABEL_2 "label=ponki" +#define TEST_METRICS_ENTRY_LABEL_1 "label=\"farfadet\"" +#define TEST_METRICS_ENTRY_LABEL_2 "label=\"ponki\"" static void set_metrics_port(or_options_t *options)

1 0