Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

Commit e6938bc

Browse files
mayurkale22mayurkale22
committed
rename metric name and description
1 parent 8548f8a commit e6938bc

4 files changed

Lines changed: 39 additions & 39 deletions

File tree

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
import io.opencensus.metrics.LabelValue;
2121

2222
/** A helper class that holds OpenCensus's related constants. */
23-
public class MetricRegistryConstants {
23+
class MetricRegistryConstants {
2424

2525
// The label keys are used to uniquely identify timeseries.
2626
private static final LabelKey DATABASE = LabelKey.create("database", "Target database");
@@ -32,22 +32,22 @@ public class MetricRegistryConstants {
3232
/** The label value is used to represent missing value. */
3333
private static final LabelValue UNSET_LABEL = LabelValue.create(null);
3434

35-
public static final ImmutableList<LabelKey> SPANNER_LABEL_KEYS =
35+
static final ImmutableList<LabelKey> SPANNER_LABEL_KEYS =
3636
ImmutableList.of(DATABASE, INSTANCE_ID, LIBRARY_VERSION);
3737

38-
public static final ImmutableList<LabelValue> SPANNER_DEFAULT_LABEL_VALUES =
38+
static final ImmutableList<LabelValue> SPANNER_DEFAULT_LABEL_VALUES =
3939
ImmutableList.of(UNSET_LABEL, UNSET_LABEL, UNSET_LABEL);
4040

4141
/** Unit to represent counts. */
42-
public static final String COUNT = "1";
42+
static final String COUNT = "1";
4343

4444
// The Metric name and description
45-
public static final String ACTIVE_SESSIONS = "cloud.google.com/java/spanner/active_sessions";
46-
public static final String MAX_SESSIONS = "cloud.google.com/java/spanner/max_sessions";
47-
public static final String SESSIONS_IN_USE = "cloud.google.com/java/spanner/sessions_in_use";
48-
public static final String ACTIVE_SESSIONS_DESCRIPTION =
49-
"Max number of sessions in use during the last 10 minutes";
50-
public static final String MAX_SESSIONS_DESCRIPTION = "The number of max sessions configured";
51-
public static final String SESSIONS_IN_USE_DESCRIPTION =
52-
"The number of sessions checked out from the pool";
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 max number of sessions in use during the last 10 minutes 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";
5353
}

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

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@
1616

1717
package com.google.cloud.spanner;
1818

19-
import static com.google.cloud.spanner.MetricRegistryConstants.ACTIVE_SESSIONS;
20-
import static com.google.cloud.spanner.MetricRegistryConstants.ACTIVE_SESSIONS_DESCRIPTION;
2119
import static com.google.cloud.spanner.MetricRegistryConstants.COUNT;
22-
import static com.google.cloud.spanner.MetricRegistryConstants.MAX_SESSIONS;
23-
import static com.google.cloud.spanner.MetricRegistryConstants.MAX_SESSIONS_DESCRIPTION;
24-
import static com.google.cloud.spanner.MetricRegistryConstants.SESSIONS_IN_USE;
25-
import static com.google.cloud.spanner.MetricRegistryConstants.SESSIONS_IN_USE_DESCRIPTION;
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;
2626
import static com.google.cloud.spanner.MetricRegistryConstants.SPANNER_DEFAULT_LABEL_VALUES;
2727
import static com.google.cloud.spanner.MetricRegistryConstants.SPANNER_LABEL_KEYS;
2828
import static com.google.cloud.spanner.SpannerExceptionFactory.newSpannerException;
@@ -1815,36 +1815,36 @@ public void onSessionCreateFailure(Throwable t, int createFailureForSessionCount
18151815
* allows users to monitor client behavior.
18161816
*/
18171817
private void initMetricsCollection(MetricRegistry metricRegistry, List<LabelValue> labelValues) {
1818-
DerivedLongGauge activeSessionsGauge =
1818+
DerivedLongGauge maxInUseSessionsMetric =
18191819
metricRegistry.addDerivedLongGauge(
1820-
ACTIVE_SESSIONS,
1820+
MAX_IN_USE_SESSIONS,
18211821
MetricOptions.builder()
1822-
.setDescription(ACTIVE_SESSIONS_DESCRIPTION)
1822+
.setDescription(MAX_IN_USE_SESSIONS_DESCRIPTION)
18231823
.setUnit(COUNT)
18241824
.setLabelKeys(SPANNER_LABEL_KEYS)
18251825
.build());
18261826

1827-
DerivedLongGauge maxSessionsGauge =
1827+
DerivedLongGauge maxAllowedSessionsMetric =
18281828
metricRegistry.addDerivedLongGauge(
1829-
MAX_SESSIONS,
1829+
MAX_ALLOWED_SESSIONS,
18301830
MetricOptions.builder()
1831-
.setDescription(MAX_SESSIONS_DESCRIPTION)
1831+
.setDescription(MAX_ALLOWED_SESSIONS_DESCRIPTION)
18321832
.setUnit(COUNT)
18331833
.setLabelKeys(SPANNER_LABEL_KEYS)
18341834
.build());
18351835

1836-
DerivedLongGauge sessionsInUseGauge =
1836+
DerivedLongGauge numInUseSessionsMetric =
18371837
metricRegistry.addDerivedLongGauge(
1838-
SESSIONS_IN_USE,
1838+
IN_USE_SESSIONS,
18391839
MetricOptions.builder()
1840-
.setDescription(SESSIONS_IN_USE_DESCRIPTION)
1840+
.setDescription(IN_USE_SESSIONS_DESCRIPTION)
18411841
.setUnit(COUNT)
18421842
.setLabelKeys(SPANNER_LABEL_KEYS)
18431843
.build());
18441844

18451845
// The value of a maxSessionsInUse is observed from a callback function. This function is
18461846
// invoked whenever metrics are collected.
1847-
activeSessionsGauge.createTimeSeries(
1847+
maxInUseSessionsMetric.createTimeSeries(
18481848
labelValues,
18491849
this,
18501850
new ToLongFunction<SessionPool>() {
@@ -1856,7 +1856,7 @@ public long applyAsLong(SessionPool sessionPool) {
18561856

18571857
// The value of a maxSessions is observed from a callback function. This function is invoked
18581858
// whenever metrics are collected.
1859-
maxSessionsGauge.createTimeSeries(
1859+
maxAllowedSessionsMetric.createTimeSeries(
18601860
labelValues,
18611861
options,
18621862
new ToLongFunction<SessionPoolOptions>() {
@@ -1868,7 +1868,7 @@ public long applyAsLong(SessionPoolOptions options) {
18681868

18691869
// The value of a numSessionsInUse is observed from a callback function. This function is
18701870
// invoked whenever metrics are collected.
1871-
sessionsInUseGauge.createTimeSeries(
1871+
numInUseSessionsMetric.createTimeSeries(
18721872
labelValues,
18731873
this,
18741874
new ToLongFunction<SessionPool>() {

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/MetricRegistryTestUtils.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@
3232
import java.util.List;
3333
import java.util.Map;
3434

35-
public class MetricRegistryTestUtils {
35+
class MetricRegistryTestUtils {
3636

37-
public static class MetricsRecord {
38-
public final Map<String, Number> metrics;
39-
public final Map<List<LabelKey>, List<LabelValue>> labels;
37+
static class MetricsRecord {
38+
final Map<String, Number> metrics;
39+
final Map<List<LabelKey>, List<LabelValue>> labels;
4040

4141
private MetricsRecord() {
4242
this.metrics = Maps.newHashMap();
@@ -78,11 +78,11 @@ public static final class FakeMetricRegistry extends MetricRegistry {
7878

7979
private MetricsRecord record;
8080

81-
public FakeMetricRegistry() {
81+
FakeMetricRegistry() {
8282
record = new MetricsRecord();
8383
}
8484

85-
public MetricsRecord pollRecord() {
85+
MetricsRecord pollRecord() {
8686
return record;
8787
}
8888

‎google-cloud-spanner/src/test/java/com/google/cloud/spanner/SessionPoolTest.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1582,11 +1582,11 @@ public void testSessionMetrics() {
15821582
runMaintainanceLoop(clock, pool, pool.poolMaintainer.numClosureCycles);
15831583

15841584
MetricsRecord record = metricRegistry.pollRecord();
1585-
assertThat(record.metrics).containsEntry(MetricRegistryConstants.ACTIVE_SESSIONS, 0L);
1586-
assertThat(record.metrics).containsEntry(MetricRegistryConstants.SESSIONS_IN_USE, 0L);
1585+
assertThat(record.metrics).containsEntry(MetricRegistryConstants.MAX_IN_USE_SESSIONS, 0L);
1586+
assertThat(record.metrics).containsEntry(MetricRegistryConstants.IN_USE_SESSIONS, 0L);
15871587
assertThat(record.metrics)
15881588
.containsEntry(
1589-
MetricRegistryConstants.MAX_SESSIONS, Long.valueOf(options.getMaxSessions()));
1589+
MetricRegistryConstants.MAX_ALLOWED_SESSIONS, Long.valueOf(options.getMaxSessions()));
15901590
assertThat(record.labels).containsEntry(SPANNER_LABEL_KEYS, labelValues);
15911591
}
15921592

0 commit comments

Comments
 (0)