Skip to content

Commit d9a00a8

Browse files
mayurkale22mayurkale22
authored
feat: instrument Spanner client with OpenCensus metrics (#54)
* feat: add session metrics Add active_sessions (The number of active sessions in use) and max_sessions (The number of max sessions configured the user) metrics * Fix code reviews Use maxSessionsInUse instead of numSessionsInUse and update the description. * Change active sessions description * add numSessionsInUse metric * Fix package structure * rename metric name and description * fix nits * createMockSession for metrics validations
1 parent ce93f87 commit d9a00a8

File tree

5 files changed

+391
-5
lines changed

5 files changed

+391
-5
lines changed

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/MetricRegistryConstants.java

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
/*
2+
* Copyright 2020 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.google.cloud.spanner;
17+
18+
import com.google.common.collect.ImmutableList;
19+
import io.opencensus.metrics.LabelKey;
20+
import io.opencensus.metrics.LabelValue;
21+
22+
/** A helper class that holds OpenCensus's related constants. */
23+
class MetricRegistryConstants {
24+
25+
// The label keys are used to uniquely identify timeseries.
26+
private static final LabelKey DATABASE = LabelKey.create("database", "Target database");
27+
private static final LabelKey INSTANCE_ID =
28+
LabelKey.create("instance_id", "Name of the instance");
29+
private static final LabelKey LIBRARY_VERSION =
30+
LabelKey.create("library_version", "Library version");
31+
32+
/** The label value is used to represent missing value. */
33+
private static final LabelValue UNSET_LABEL = LabelValue.create(null);
34+
35+
static final ImmutableList<LabelKey> SPANNER_LABEL_KEYS =
36+
ImmutableList.of(DATABASE, INSTANCE_ID, LIBRARY_VERSION);
37+
38+
static final ImmutableList<LabelValue> SPANNER_DEFAULT_LABEL_VALUES =
39+
ImmutableList.of(UNSET_LABEL, UNSET_LABEL, UNSET_LABEL);
40+
41+
/** Unit to represent counts. */
42+
static final String COUNT = "1";
43+
44+
// The Metric name and description
45+
static final String MAX_IN_USE_SESSIONS = "cloud.google.com/java/spanner/max_in_use_session";
46+
static final String MAX_ALLOWED_SESSIONS = "cloud.google.com/java/spanner/max_allowed_sessions";
47+
static final String IN_USE_SESSIONS = "cloud.google.com/java/spanner/in_use_sessions";
48+
static final String MAX_IN_USE_SESSIONS_DESCRIPTION =
49+
"The maximum number of sessions in use during the last 10 minute interval.";
50+
static final String MAX_ALLOWED_SESSIONS_DESCRIPTION =
51+
"The maximum number of sessions allowed. Configurable by the user.";
52+
static final String IN_USE_SESSIONS_DESCRIPTION = "The number of sessions currently in use.";
53+
}

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/SessionPool.java

+119-4
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@
1616

1717
package com.google.cloud.spanner;
1818

19+
import static com.google.cloud.spanner.MetricRegistryConstants.COUNT;
20+
import static com.google.cloud.spanner.MetricRegistryConstants.IN_USE_SESSIONS;
21+
import static com.google.cloud.spanner.MetricRegistryConstants.IN_USE_SESSIONS_DESCRIPTION;
22+
import static com.google.cloud.spanner.MetricRegistryConstants.MAX_ALLOWED_SESSIONS;
23+
import static com.google.cloud.spanner.MetricRegistryConstants.MAX_ALLOWED_SESSIONS_DESCRIPTION;
24+
import static com.google.cloud.spanner.MetricRegistryConstants.MAX_IN_USE_SESSIONS;
25+
import static com.google.cloud.spanner.MetricRegistryConstants.MAX_IN_USE_SESSIONS_DESCRIPTION;
26+
import static com.google.cloud.spanner.MetricRegistryConstants.SPANNER_DEFAULT_LABEL_VALUES;
27+
import static com.google.cloud.spanner.MetricRegistryConstants.SPANNER_LABEL_KEYS;
1928
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
2029

2130
import com.google.api.core.ApiFuture;
@@ -40,6 +49,12 @@
4049
import com.google.common.util.concurrent.Uninterruptibles;
4150
import com.google.protobuf.Empty;
4251
import io.opencensus.common.Scope;
52+
import io.opencensus.common.ToLongFunction;
53+
import io.opencensus.metrics.DerivedLongGauge;
54+
import io.opencensus.metrics.LabelValue;
55+
import io.opencensus.metrics.MetricOptions;
56+
import io.opencensus.metrics.MetricRegistry;
57+
import io.opencensus.metrics.Metrics;
4358
import io.opencensus.trace.Annotation;
4459
import io.opencensus.trace.AttributeValue;
4560
import io.opencensus.trace.Span;
@@ -49,6 +64,7 @@
4964
import java.util.HashSet;
5065
import java.util.Iterator;
5166
import java.util.LinkedList;
67+
import java.util.List;
5268
import java.util.Queue;
5369
import java.util.Random;
5470
import java.util.Set;
@@ -1116,11 +1132,15 @@ private static enum Position {
11161132
* Return pool is immediately ready for use, though getting a session might block for sessions to
11171133
* be created.
11181134
*/
1119-
static SessionPool createPool(SpannerOptions spannerOptions, SessionClient sessionClient) {
1135+
static SessionPool createPool(
1136+
SpannerOptions spannerOptions, SessionClient sessionClient, List<LabelValue> labelValues) {
11201137
return createPool(
11211138
spannerOptions.getSessionPoolOptions(),
11221139
((GrpcTransportOptions) spannerOptions.getTransportOptions()).getExecutorFactory(),
1123-
sessionClient);
1140+
sessionClient,
1141+
new Clock(),
1142+
Metrics.getMetricRegistry(),
1143+
labelValues);
11241144
}
11251145

11261146
static SessionPool createPool(
@@ -1135,8 +1155,31 @@ static SessionPool createPool(
11351155
ExecutorFactory<ScheduledExecutorService> executorFactory,
11361156
SessionClient sessionClient,
11371157
Clock clock) {
1158+
return createPool(
1159+
poolOptions,
1160+
executorFactory,
1161+
sessionClient,
1162+
clock,
1163+
Metrics.getMetricRegistry(),
1164+
SPANNER_DEFAULT_LABEL_VALUES);
1165+
}
1166+
1167+
static SessionPool createPool(
1168+
SessionPoolOptions poolOptions,
1169+
ExecutorFactory<ScheduledExecutorService> executorFactory,
1170+
SessionClient sessionClient,
1171+
Clock clock,
1172+
MetricRegistry metricRegistry,
1173+
List<LabelValue> labelValues) {
11381174
SessionPool pool =
1139-
new SessionPool(poolOptions, executorFactory, executorFactory.get(), sessionClient, clock);
1175+
new SessionPool(
1176+
poolOptions,
1177+
executorFactory,
1178+
executorFactory.get(),
1179+
sessionClient,
1180+
clock,
1181+
metricRegistry,
1182+
labelValues);
11401183
pool.initPool();
11411184
return pool;
11421185
}
@@ -1146,13 +1189,16 @@ private SessionPool(
11461189
ExecutorFactory<ScheduledExecutorService> executorFactory,
11471190
ScheduledExecutorService executor,
11481191
SessionClient sessionClient,
1149-
Clock clock) {
1192+
Clock clock,
1193+
MetricRegistry metricRegistry,
1194+
List<LabelValue> labelValues) {
11501195
this.options = options;
11511196
this.executorFactory = executorFactory;
11521197
this.executor = executor;
11531198
this.sessionClient = sessionClient;
11541199
this.clock = clock;
11551200
this.poolMaintainer = new PoolMaintainer();
1201+
this.initMetricsCollection(metricRegistry, labelValues);
11561202
}
11571203

11581204
@VisibleForTesting
@@ -1766,4 +1812,73 @@ public void onSessionCreateFailure(Throwable t, int createFailureForSessionCount
17661812
}
17671813
}
17681814
}
1815+
1816+
/**
1817+
* Initializes and creates Spanner session relevant metrics. When coupled with an exporter, it
1818+
* allows users to monitor client behavior.
1819+
*/
1820+
private void initMetricsCollection(MetricRegistry metricRegistry, List<LabelValue> labelValues) {
1821+
DerivedLongGauge maxInUseSessionsMetric =
1822+
metricRegistry.addDerivedLongGauge(
1823+
MAX_IN_USE_SESSIONS,
1824+
MetricOptions.builder()
1825+
.setDescription(MAX_IN_USE_SESSIONS_DESCRIPTION)
1826+
.setUnit(COUNT)
1827+
.setLabelKeys(SPANNER_LABEL_KEYS)
1828+
.build());
1829+
1830+
DerivedLongGauge maxAllowedSessionsMetric =
1831+
metricRegistry.addDerivedLongGauge(
1832+
MAX_ALLOWED_SESSIONS,
1833+
MetricOptions.builder()
1834+
.setDescription(MAX_ALLOWED_SESSIONS_DESCRIPTION)
1835+
.setUnit(COUNT)
1836+
.setLabelKeys(SPANNER_LABEL_KEYS)
1837+
.build());
1838+
1839+
DerivedLongGauge numInUseSessionsMetric =
1840+
metricRegistry.addDerivedLongGauge(
1841+
IN_USE_SESSIONS,
1842+
MetricOptions.builder()
1843+
.setDescription(IN_USE_SESSIONS_DESCRIPTION)
1844+
.setUnit(COUNT)
1845+
.setLabelKeys(SPANNER_LABEL_KEYS)
1846+
.build());
1847+
1848+
// The value of a maxSessionsInUse is observed from a callback function. This function is
1849+
// invoked whenever metrics are collected.
1850+
maxInUseSessionsMetric.createTimeSeries(
1851+
labelValues,
1852+
this,
1853+
new ToLongFunction<SessionPool>() {
1854+
@Override
1855+
public long applyAsLong(SessionPool sessionPool) {
1856+
return sessionPool.maxSessionsInUse;
1857+
}
1858+
});
1859+
1860+
// The value of a maxSessions is observed from a callback function. This function is invoked
1861+
// whenever metrics are collected.
1862+
maxAllowedSessionsMetric.createTimeSeries(
1863+
labelValues,
1864+
options,
1865+
new ToLongFunction<SessionPoolOptions>() {
1866+
@Override
1867+
public long applyAsLong(SessionPoolOptions options) {
1868+
return options.getMaxSessions();
1869+
}
1870+
});
1871+
1872+
// The value of a numSessionsInUse is observed from a callback function. This function is
1873+
// invoked whenever metrics are collected.
1874+
numInUseSessionsMetric.createTimeSeries(
1875+
labelValues,
1876+
this,
1877+
new ToLongFunction<SessionPool>() {
1878+
@Override
1879+
public long applyAsLong(SessionPool sessionPool) {
1880+
return sessionPool.numSessionsInUse;
1881+
}
1882+
});
1883+
}
17691884
}

‎google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java

+10-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
package com.google.cloud.spanner;
1818

19+
import com.google.api.gax.core.GaxProperties;
1920
import com.google.api.gax.paging.Page;
2021
import com.google.cloud.BaseService;
2122
import com.google.cloud.PageImpl;
@@ -27,8 +28,10 @@
2728
import com.google.common.annotations.VisibleForTesting;
2829
import com.google.common.base.Preconditions;
2930
import com.google.common.base.Strings;
31+
import com.google.common.collect.ImmutableList;
3032
import com.google.common.util.concurrent.Futures;
3133
import com.google.common.util.concurrent.ListenableFuture;
34+
import io.opencensus.metrics.LabelValue;
3235
import io.opencensus.trace.Tracer;
3336
import io.opencensus.trace.Tracing;
3437
import java.util.ArrayList;
@@ -142,8 +145,14 @@ public DatabaseClient getDatabaseClient(DatabaseId db) {
142145
if (dbClients.containsKey(db)) {
143146
return dbClients.get(db);
144147
} else {
148+
List<LabelValue> labelValues =
149+
ImmutableList.of(
150+
LabelValue.create(db.getDatabase()),
151+
LabelValue.create(db.getInstanceId().getName()),
152+
LabelValue.create(GaxProperties.getLibraryVersion(getOptions().getClass())));
145153
SessionPool pool =
146-
SessionPool.createPool(getOptions(), SpannerImpl.this.getSessionClient(db));
154+
SessionPool.createPool(
155+
getOptions(), SpannerImpl.this.getSessionClient(db), labelValues);
147156
DatabaseClientImpl dbClient = createDatabaseClient(pool);
148157
dbClients.put(db, dbClient);
149158
return dbClient;

0 commit comments

Comments
 (0)