Add Armeria version metric #2179

matsumana · 2019-10-10T13:40:34Z

Hello, I've added Armeria version metric.

Motivation:

Want to check Armeria version with Grafana
FYI:
In Prometheus best practices, this kind of metric is described as follows.
https://prometheus.io/docs/practices/naming/

foobar_build_info (for a pseudo-metric that provides metadata about the running binary)

e.g.

# HELP node_exporter_build_info A metric with a constant '1' value labeled by version, revision, branch, and goversion from which node_exporter was built.
# TYPE node_exporter_build_info gauge
node_exporter_build_info{branch="master",goversion="go1.7.5",revision="840ba5dcc71a084a3bc63cb6063003c1f94435a6",version="0.14.0"} 1

Modifications:

Add Armeria version metric

Result:

It's exported as follows

Labels:

commit
version

# HELP armeria_build_info A metric with a constant '1' value labeled by version and commit hash from which Armeria was built.
# TYPE armeria_build_info gauge
armeria_build_info{commit="74700d402178e00045b1ca23006f7f6131b2a92d",version="0.94.1-SNAPSHOT",} 1.0

example dashboard:

trustin · 2019-10-10T15:24:33Z

That is awesome, @matsumana. I love it! What do you think about adding other labels such as repoStatus whose value is clean or dirty?

codecov · 2019-10-11T04:31:22Z

Codecov Report

Merging #2179 into master will decrease coverage by 0.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #2179      +/-   ##
============================================
- Coverage     73.62%   73.61%   -0.02%     
+ Complexity     9581     9580       -1     
============================================
  Files           837      837              
  Lines         36883    36898      +15     
  Branches       4548     4548              
============================================
+ Hits          27155    27162       +7     
- Misses         7402     7412      +10     
+ Partials       2326     2324       -2

Impacted Files	Coverage Δ	Complexity Δ
.../main/java/com/linecorp/armeria/server/Server.java	`83.92% <100%> (+1%)`	`29 <2> (+2)`	⬆️
.../linecorp/armeria/client/Http2ResponseDecoder.java	`60.83% <0%> (-3.34%)`	`32% <0%> (-1%)`
...necorp/armeria/server/GracefulShutdownSupport.java	`97.43% <0%> (-2.57%)`	`4% <0%> (ø)`
...com/linecorp/armeria/server/saml/SamlEndpoint.java	`62.5% <0%> (-2.5%)`	`10% <0%> (-1%)`
...rp/armeria/common/stream/DefaultStreamMessage.java	`89.36% <0%> (-1.42%)`	`53% <0%> (-1%)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 84d3b36...a61269b. Read the comment docs.

anuraaga

Cool feature

anuraaga · 2019-10-11T04:34:05Z

core/src/test/java/com/linecorp/armeria/server/ServerTest.java

+        final MeterRegistry meterRegistry = server.config().meterRegistry();
+        assertThat(meterRegistry.find("armeria.build.info")
+                                .gauge()
+                                .value())


How about also checking the three tags exist (though not checking their values which isn't constant)

matsumana · 2019-10-11T04:48:36Z

What do you think about adding other labels such as repoStatus whose value is clean or dirty?

Sounds good.
Added!

# HELP armeria_build_info A metric with a constant '1' value labeled by version and commit hash from which Armeria was built.
# TYPE armeria_build_info gauge
armeria_build_info{commit="74700d402178e00045b1ca23006f7f6131b2a92d",repostatus="dirty",version="0.94.1-SNAPSHOT",} 1.0

I added repostatus, not repoStatus.
I followed node_exporter's label naming.
e.g.
node_filesystem_free{device="/dev/sda2",fstype="ext4",mountpoint="/"} 8.4968587264e+10

anuraaga

Thanks!

minwoox

Thanks!

ikhoon

👍 Thanks! @matsumana

trustin

Just two nits. Let me push a change directly to your branch and merge. Thank you!

core/src/main/java/com/linecorp/armeria/server/Server.java

trustin · 2019-10-17T06:19:19Z

I added repostatus, not repoStatus.
I followed node_exporter's label naming.

Oh, just found this comment. Armeria currently is using camel case convention for label names, e.g. hostnamePattern, so I changed it to repoStatus. Do you think we should make them all lower-cased?

matsumana · 2019-10-17T14:05:09Z

Oh, just found this comment. Armeria currently is using camel case convention for label names, e.g. hostnamePattern, so I changed it to repoStatus. Do you think we should make them all lower-cased?

It was my misunderstanding.
I remembered that you guys were discussing about metrics naming conventions in a issue/PR before, so I misunderstood that you are going to migrate from camelCase.

Thank you for changing the label.
Could you merge?

trustin · 2019-10-17T14:20:50Z

Ah, it was about meter names rather than label names :-) Will merge soon!

trustin · 2019-10-18T07:07:11Z

Much appreciated, @matsumana ! 👍

matsumana · 2019-10-18T09:21:18Z

Thank you!

Motivation: - Want to check Armeria version with Grafana FYI: In Prometheus best practices, this kind of metric is described as follows. https://prometheus.io/docs/practices/naming/ > foobar_build_info (for a pseudo-metric that provides metadata about the running binary) e.g. ``` # HELP node_exporter_build_info A metric with a constant '1' value labeled by version, revision, branch, and goversion from which node_exporter was built. # TYPE node_exporter_build_info gauge node_exporter_build_info{branch="master",goversion="go1.7.5",revision="840ba5dcc71a084a3bc63cb6063003c1f94435a6",version="0.14.0"} 1 ``` Modifications: - Add Armeria version metric Result: It's exported as follows: Labels: - `commit` - `version` - `repoStatus` ``` # HELP armeria_build_info A metric with a constant '1' value labeled by version and commit hash from which Armeria was built. # TYPE armeria_build_info gauge armeria_build_info{commit="74700d402178e00045b1ca23006f7f6131b2a92d",version="0.94.1-SNAPSHOT",repoStatus="clean"} 1.0 ```

Add Armeria version metric

74700d4

matsumana requested review from ikhoon, minwoox and trustin as code owners October 10, 2019 13:40

ikhoon added the new feature label Oct 10, 2019

Add repostatus in metrics labels

eaf102d

anuraaga reviewed Oct 11, 2019

View reviewed changes

matsumana added 2 commits October 11, 2019 14:11

Check whether labels are existing

d8e1b7e

Fix assertion

a851312

anuraaga approved these changes Oct 11, 2019

View reviewed changes

minwoox approved these changes Oct 14, 2019

View reviewed changes

ikhoon approved these changes Oct 14, 2019

View reviewed changes

ikhoon added this to the 0.95.0 milestone Oct 14, 2019

trustin approved these changes Oct 17, 2019

View reviewed changes

core/src/main/java/com/linecorp/armeria/server/Server.java Outdated Show resolved Hide resolved

core/src/main/java/com/linecorp/armeria/server/Server.java Outdated Show resolved Hide resolved

trustin added 2 commits October 17, 2019 15:15

Update Server.java

63cdbda

Update ServerTest.java

f82bb75

Update Server.java

a61269b

trustin merged commit 29e55e7 into line:master Oct 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Armeria version metric #2179

Add Armeria version metric #2179

matsumana commented Oct 10, 2019

trustin commented Oct 10, 2019

codecov bot commented Oct 11, 2019 •

edited

Loading

anuraaga left a comment

anuraaga Oct 11, 2019

matsumana commented Oct 11, 2019

anuraaga left a comment

minwoox left a comment

ikhoon left a comment

trustin left a comment

trustin commented Oct 17, 2019

matsumana commented Oct 17, 2019

trustin commented Oct 17, 2019

trustin commented Oct 18, 2019

matsumana commented Oct 18, 2019

Add Armeria version metric #2179

Add Armeria version metric #2179

Conversation

matsumana commented Oct 10, 2019

trustin commented Oct 10, 2019

codecov bot commented Oct 11, 2019 • edited Loading

Codecov Report

anuraaga left a comment

Choose a reason for hiding this comment

anuraaga Oct 11, 2019

Choose a reason for hiding this comment

matsumana commented Oct 11, 2019

anuraaga left a comment

Choose a reason for hiding this comment

minwoox left a comment

Choose a reason for hiding this comment

ikhoon left a comment

Choose a reason for hiding this comment

trustin left a comment

Choose a reason for hiding this comment

trustin commented Oct 17, 2019

matsumana commented Oct 17, 2019

trustin commented Oct 17, 2019

trustin commented Oct 18, 2019

matsumana commented Oct 18, 2019

codecov bot commented Oct 11, 2019 •

edited

Loading