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

Jump to bottom

metrics-probe: add new parser which generates stats counters #4318

Merged

MrAnno merged 12 commits into syslog-ng:master from alltilla:metrics-probe

Feb 28, 2023

Collaborator

alltilla commented Feb 9, 2023 •

edited

This kind of parser counts messages passing through, based on the metadata of each message. It creates labeled stats counters based on the fields of the message. Both the key and labels can be set in the config, the values of the labels can be templated.

Both the key and labels can be set in the config, the values of the labels can be templated. E.g.:

parser p_metrics_probe {
  metrics-probe(
    key("custom_key")  # adds "syslogng_" prefix => "syslogng_custom_key"
    labels(
      "custom_label_name_1" => "foobar"
      "custom_label_name_2" => "${.custom.field}"
    )
  );
};

With this config, it creates counters like these:

syslogng_custom_key{custom_label_name_1="foobar", custom_label_name_2="bar"} 1
syslogng_custom_key{custom_label_name_1="foobar", custom_label_name_2="foo"} 1
syslogng_custom_key{custom_label_name_1="foobar", custom_label_name_2="baz"} 3

The minimal config creates counters with the key syslogng_classified_events_total and labels app, host, program and source. E.g.:

parser p_metrics_probe {
  metrics-probe();

  # Same as:
  #
  # metrics-probe(
  #   key("classified_events_total")
  #   labels(
  #     "app" => "${APP}"
  #     "host" => "${HOST}"
  #     "program" => "${PROGRAM}"
  #     "source" => "${SOURCE}"
  #   )
  # );
};

With this config, it creates counters like these:

syslogng_classified_events_total{app="example-app", host="localhost", program="baz", source="s_local_1"} 3
syslogng_classified_events_total{app="example-app", host="localhost", program="bar", source="s_local_1"} 1
syslogng_classified_events_total{app="example-app", host="localhost", program="foo", source="s_local_1"} 1

Depends on #4325

Signed-off-by: Attila Szakacs szakacs.attila96@gmail.com

alltilla marked this pull request as draft

February 9, 2023 11:00

Contributor

github-actions bot commented Feb 9, 2023

No news file has been detected. Please write one, if applicable.

alltilla force-pushed the metrics-probe branch from 4132a5a to ca0884a Compare

February 9, 2023 11:03

Contributor

kira-syslogng commented Feb 9, 2023

Build FAILURE

Collaborator Author

alltilla commented Feb 9, 2023

@kira-syslogng retest this please

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

0f3fa59

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from ca0884a to 0f3fa59 Compare

February 10, 2023 14:00

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from 0f3fa59 to 6721749 Compare

February 15, 2023 08:47

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

024bd1b

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from 6721749 to 024bd1b Compare

February 16, 2023 11:30

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

f71a744

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from 024bd1b to f71a744 Compare

February 16, 2023 11:30

MrAnno mentioned this pull request

New metric system (Prometheus data format) #4325

Merged

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from f71a744 to 3949620 Compare

February 16, 2023 20:53

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

b4ce059

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from 3949620 to b4ce059 Compare

February 16, 2023 21:08

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

84e20b8

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from b4ce059 to 84e20b8 Compare

February 17, 2023 09:13

MrAnno self-requested a review

February 17, 2023 13:50

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

ec70003

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from 84e20b8 to ec70003 Compare

February 20, 2023 11:00

MrAnno reviewed

View reviewed changes

Collaborator

MrAnno left a comment

This is great :)

lib/apphook.c Outdated Show resolved Hide resolved

modules/metrics-probe/metrics-probe.c Outdated Show resolved Hide resolved

modules/metrics-probe/metrics-probe.c Outdated Show resolved Hide resolved

modules/metrics-probe/metrics-probe.c Outdated Show resolved Hide resolved

modules/metrics-probe/metrics-probe.c Outdated Show resolved Hide resolved

modules/metrics-probe/metrics-probe.c Outdated Show resolved Hide resolved

modules/metrics-probe/metrics-probe.c Outdated Show resolved Hide resolved

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

0a10951

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from ec70003 to 0a10951 Compare

February 21, 2023 10:28

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

c07e011

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from 0a10951 to c07e011 Compare

February 21, 2023 11:25

alltilla marked this pull request as ready for review

February 21, 2023 11:40

MrAnno previously approved these changes

View reviewed changes

Collaborator

MrAnno left a comment

LGTM.

MrAnno added this to the syslog-ng 4.1 milestone

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

ae08f3a

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla dismissed MrAnno’s stale review via

ae08f3a

February 24, 2023 14:07

alltilla force-pushed the metrics-probe branch from c07e011 to ae08f3a Compare

February 24, 2023 14:07

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

0f4841f

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla force-pushed the metrics-probe branch from ae08f3a to 0f4841f Compare

February 27, 2023 08:07

MrAnno previously approved these changes

View reviewed changes

Collaborator

MrAnno left a comment

👍🏻👍🏻

alltilla added a commit to alltilla/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

7d4aa53

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla dismissed MrAnno’s stale review via

7d4aa53

February 28, 2023 08:26

alltilla force-pushed the metrics-probe branch from 0f4841f to 7d4aa53 Compare

February 28, 2023 08:26

MrAnno previously approved these changes

View reviewed changes

alltilla added 12 commits

February 28, 2023 12:01


          stats-cluster-singe: add get_counter()

fc83dd3

As single stats clusters always store only one counter, we can always
pinpoint that.

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          apphook: add option to register thread init and deinit hooks

dbbec81

This can be useful for plugins, which implement (de)initializable
Thread Local Storage variables.

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add skeleton

9ae9b6f

This kind of parser counts messages passing through, based on the
metadata of each message. It creates labeled stats counters based on the
fields of the message. Both the key and labels can be set in the config,
the values of the labels can be templated.

This commit creates the skeleton for this parser, the implementation
will be done in the following commits.

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add key() option

9ec9caf

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add LabelTemplate class

50d02e6

This will be useful for storing and formatting the label templates set
in the config.

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add labels() option

9f85a97

Why do we need to limit the number of labels?

We need allocated memory for the formatted labels, so we can create
a `StatsClusterKey` from them. We could store a buffer for them in the
class, but that would make it stateful, which means we need to lock it
in the `process()` function
Alternatively we could `malloc()` it in each `process()` call, but it
is costly.

If the number of labels is limited, we can allocate them on the stack
in the `process()` function, which means we save a per message
`malloc()` and manage to keep the parser stateless.

The downside is that we put a limit on it, but I don't think that having
more than 32 labels is sensible.

Everything mentioned in this commit message will become cleaner in the
next commits, where the labels get used.

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: support template_options

b55b445

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: implement creating and increasing counters

7f7d922

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add unit test for defaults

3b9322c

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add unit tests for custom key and labels

403437e

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          metrics-probe: add unit test for stats-max-dynamics()

899f03f

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>


          news: add entry for syslog-ng#4318

4b9cb8d

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

alltilla dismissed MrAnno’s stale review via

4b9cb8d

February 28, 2023 11:07

alltilla force-pushed the metrics-probe branch from 7d4aa53 to 4b9cb8d Compare

February 28, 2023 11:07

MrAnno approved these changes

View reviewed changes

MrAnno merged commit 11f0514 into syslog-ng:master

27 checks passed

Genfood pushed a commit to Genfood/syslog-ng that referenced this pull request


          news: add entry for syslog-ng#4318

02f7410

Signed-off-by: Attila Szakacs <szakacs.attila96@gmail.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment