Skip to content
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

Add Armeria version metric #2179

Merged
merged 7 commits into from
Oct 18, 2019
+41 −0
Merged

Add Armeria version metric #2179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
74700d4
Add Armeria version metric
matsumana Oct 10, 2019
eaf102d
Add repostatus in metrics labels
matsumana Oct 11, 2019
d8e1b7e
Check whether labels are existing
matsumana Oct 11, 2019
a851312
Fix assertion
matsumana Oct 11, 2019
63cdbda
Update Server.java
trustin Oct 17, 2019
f82bb75
Update ServerTest.java
trustin Oct 17, 2019
a61269b
Update Server.java
trustin Oct 17, 2019
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
27 changes: 27 additions & 0 deletions core/src/main/java/com/linecorp/armeria/server/Server.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Joiner;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSet.Builder;
import com.google.common.collect.Iterables;
Expand All @@ -58,13 +59,16 @@
import com.linecorp.armeria.common.metric.MeterIdPrefix;
import com.linecorp.armeria.common.util.EventLoopGroups;
import com.linecorp.armeria.common.util.StartStopSupport;
import com.linecorp.armeria.common.util.Version;
import com.linecorp.armeria.internal.ChannelUtil;
import com.linecorp.armeria.internal.ConnectionLimitingHandler;
import com.linecorp.armeria.internal.PathAndQuery;
import com.linecorp.armeria.internal.TransportType;
import com.linecorp.armeria.server.logging.AccessLogWriter;

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.Channel;
import io.netty.channel.ChannelFuture;
Expand Down Expand Up @@ -118,6 +122,8 @@ public static ServerBuilder builder() {
final MeterIdPrefix idPrefix = new MeterIdPrefix("armeria.server.parsedPathCache");
PathAndQuery.registerMetrics(config.meterRegistry(), idPrefix);

setupVersionMetrics();

// Invoke the serviceAdded() method in Service so that it can keep the reference to this Server or
// add a listener to it.
config.serviceConfigs().forEach(cfg -> ServiceCallbackInvoker.invokeServiceAdded(cfg, cfg.service()));
Expand Down Expand Up @@ -305,6 +311,27 @@ public int numConnections() {
return connectionLimitingHandler.numConnections();
}

/**
* Sets up the version metrics.
*/
@VisibleForTesting
void setupVersionMetrics() {
final MeterRegistry meterRegistry = config().meterRegistry();
final Map<String, Version> map = Version.identify(getClass().getClassLoader());
final Version versionInfo = map.get("armeria");
final String version = versionInfo.artifactVersion();
final String commit = versionInfo.longCommitHash();
final String repositoryStatus = versionInfo.repositoryStatus();
final List<Tag> tags = ImmutableList.of(Tag.of("version", version),
Tag.of("commit", commit),
Tag.of("repoStatus", repositoryStatus));
Gauge.builder("armeria.build.info", () -> 1)
.tags(tags)
.description("A metric with a constant '1' value labeled by version and commit hash" +
" from which Armeria was built.")
.register(meterRegistry);
}

@Override
public String toString() {
return MoreObjects.toStringHelper(this)
Expand Down
14 changes: 14 additions & 0 deletions core/src/test/java/com/linecorp/armeria/server/ServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@
import com.linecorp.armeria.testing.internal.AnticipatedException;
import com.linecorp.armeria.testing.junit4.server.ServerRule;

import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.netty.channel.ChannelOption;
import io.netty.handler.codec.http.HttpStatusClass;
Expand Down Expand Up @@ -436,6 +437,19 @@ public void notGracefulShutdownBlockingTaskExecutor() {
assertThat(MoreExecutors.shutdownAndAwaitTermination(executor, 10, TimeUnit.SECONDS)).isTrue();
}

@Test
public void versionMetrics() {
final Server server = ServerTest.server.server();
server.setupVersionMetrics();

final MeterRegistry meterRegistry = server.config().meterRegistry();
final Gauge gauge = meterRegistry.find("armeria.build.info")
.tagKeys("version", "commit", "repoStatus")
.gauge();
assertThat(gauge).isNotNull();
assertThat(gauge.value()).isOne();
}

private static void testSimple(
String reqLine, String expectedStatusLine, String... expectedHeaders) throws Exception {

Expand Down