mirror of
https://github.com/google/nomulus
synced 2026-01-07 05:56:49 +00:00
Write GKE metrics with the apprioate labels (#2626)
Also makes preperations to expose the sidecar proxy.
This commit is contained in:
Lai Jiang
GitHub
148
util/src/main/java/google/registry/util/MetricParameters.java
Normal file
148
util/src/main/java/google/registry/util/MetricParameters.java
Normal file
@@ -0,0 +1,148 @@
|
||||
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package google.registry.util;
|
||||
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
|
||||
import com.google.api.services.monitoring.v3.model.MonitoredResource;
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
import com.google.common.flogger.FluentLogger;
|
||||
import com.google.common.io.CharStreams;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStreamReader;
|
||||
import java.net.HttpURLConnection;
|
||||
import java.net.MalformedURLException;
|
||||
import java.net.URI;
|
||||
import java.net.URISyntaxException;
|
||||
import java.util.Map;
|
||||
import java.util.function.Function;
|
||||
import javax.inject.Inject;
|
||||
|
||||
/**
|
||||
* Utility class to obtain labels for monitored resource of type {@code gke_container}.
|
||||
*
|
||||
* <p>Custom metrics collected by the proxy need to be associated with a {@link MonitoredResource}.
|
||||
* When running on GKE, the type is {@code gke_container}. The labels for this type are used to
|
||||
* group related metrics together, and to avoid out-of-order metrics writes. This class provides a
|
||||
* map of the labels where the values are either read from environment variables (pod and container
|
||||
* related labels) or queried from GCE metadata server (cluster and instance related labels).
|
||||
*
|
||||
* @see <a
|
||||
* href="https://cloud.google.com/monitoring/custom-metrics/creating-metrics#which-resource">
|
||||
* Creating Custom Metrics - Choosing a monitored resource type</a>
|
||||
* @see <a href="https://cloud.google.com/monitoring/api/resources#tag_gke_container">Monitored
|
||||
* Resource Types - gke_container</a>
|
||||
* @see <a href="https://cloud.google.com/compute/docs/storing-retrieving-metadata#querying">Storing
|
||||
* and Retrieving Instance Metadata - Getting metadata</a>
|
||||
* @see <a
|
||||
* href="https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/">
|
||||
* Expose Pod Information to Containers Through Environment Variables </a>
|
||||
*/
|
||||
public class MetricParameters {
|
||||
|
||||
// Environment variable names, defined in the GKE deployment pod spec.
|
||||
static final String NAMESPACE_ID_ENV = "NAMESPACE_ID";
|
||||
static final String POD_ID_ENV = "POD_ID";
|
||||
static final String CONTAINER_NAME_ENV = "CONTAINER_NAME";
|
||||
|
||||
// GCE metadata server URLs to retrieve instance related information.
|
||||
private static final String GCE_METADATA_URL_BASE = "http://metadata.google.internal/";
|
||||
static final String PROJECT_ID_PATH = "computeMetadata/v1/project/project-id";
|
||||
static final String CLUSTER_NAME_PATH = "computeMetadata/v1/instance/attributes/cluster-name";
|
||||
static final String INSTANCE_ID_PATH = "computeMetadata/v1/instance/id";
|
||||
static final String ZONE_PATH = "computeMetadata/v1/instance/zone";
|
||||
|
||||
private static final FluentLogger logger = FluentLogger.forEnclosingClass();
|
||||
|
||||
private final Map<String, String> envVarMap;
|
||||
private final Function<String, HttpURLConnection> connectionFactory;
|
||||
|
||||
MetricParameters(
|
||||
Map<String, String> envVarMap, Function<String, HttpURLConnection> connectionFactory) {
|
||||
this.envVarMap = envVarMap;
|
||||
this.connectionFactory = connectionFactory;
|
||||
}
|
||||
|
||||
@Inject
|
||||
MetricParameters() {
|
||||
this(ImmutableMap.copyOf(System.getenv()), MetricParameters::gceConnectionFactory);
|
||||
}
|
||||
|
||||
private static HttpURLConnection gceConnectionFactory(String path) {
|
||||
String url = GCE_METADATA_URL_BASE + path;
|
||||
try {
|
||||
HttpURLConnection connection = (HttpURLConnection) new URI(url).toURL().openConnection();
|
||||
connection.setRequestMethod("GET");
|
||||
// The metadata server requires this header to be set when querying from a GCE instance.
|
||||
connection.setRequestProperty("Metadata-Flavor", "Google");
|
||||
connection.setDoOutput(true);
|
||||
return connection;
|
||||
} catch (URISyntaxException | MalformedURLException e) {
|
||||
throw new RuntimeException(String.format("Incorrect GCE metadata server URL: %s", url), e);
|
||||
} catch (IOException e) {
|
||||
throw new RuntimeException(
|
||||
String.format("Cannot connect to GCE metadata server: %s", url), e);
|
||||
}
|
||||
}
|
||||
|
||||
private String readEnvVar(String envVar) {
|
||||
return envVarMap.getOrDefault(envVar, "");
|
||||
}
|
||||
|
||||
private String readGceMetadata(String path) {
|
||||
String value = "";
|
||||
HttpURLConnection connection = connectionFactory.apply(path);
|
||||
try {
|
||||
connection.connect();
|
||||
int responseCode = connection.getResponseCode();
|
||||
if (responseCode < 200 || responseCode > 299) {
|
||||
logger.atWarning().log(
|
||||
"Got an error response: %d\n%s",
|
||||
responseCode,
|
||||
CharStreams.toString(new InputStreamReader(connection.getErrorStream(), UTF_8)));
|
||||
} else {
|
||||
value = CharStreams.toString(new InputStreamReader(connection.getInputStream(), UTF_8));
|
||||
}
|
||||
} catch (IOException e) {
|
||||
logger.atWarning().withCause(e).log("Cannot obtain GCE metadata from path %s", path);
|
||||
}
|
||||
return value;
|
||||
}
|
||||
|
||||
public ImmutableMap<String, String> makeLabelsMap() {
|
||||
// The zone metadata is in the form of "projects/<PROJECT_NUMERICAL_ID>/zones/<ZONE_NAME>".
|
||||
// We only need the last part after the slash.
|
||||
String fullZone = readGceMetadata(ZONE_PATH);
|
||||
String zone;
|
||||
String[] fullZoneArray = fullZone.split("/", -1);
|
||||
if (fullZoneArray.length < 4) {
|
||||
logger.atWarning().log("Zone %s is valid.", fullZone);
|
||||
// This will make the metric report throw, but it happens in a different thread and will not
|
||||
// kill the whole application.
|
||||
zone = "";
|
||||
} else {
|
||||
zone = fullZoneArray[3];
|
||||
}
|
||||
return new ImmutableMap.Builder<String, String>()
|
||||
.put("project_id", readGceMetadata(PROJECT_ID_PATH))
|
||||
.put("cluster_name", readGceMetadata(CLUSTER_NAME_PATH))
|
||||
.put("namespace_id", readEnvVar(NAMESPACE_ID_ENV))
|
||||
.put("instance_id", readGceMetadata(INSTANCE_ID_PATH))
|
||||
.put("pod_id", readEnvVar(POD_ID_ENV))
|
||||
.put("container_name", readEnvVar(CONTAINER_NAME_ENV))
|
||||
.put("zone", zone)
|
||||
.build();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,133 @@
|
||||
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package google.registry.util;
|
||||
|
||||
import static com.google.common.truth.Truth.assertThat;
|
||||
import static google.registry.util.MetricParameters.CLUSTER_NAME_PATH;
|
||||
import static google.registry.util.MetricParameters.CONTAINER_NAME_ENV;
|
||||
import static google.registry.util.MetricParameters.INSTANCE_ID_PATH;
|
||||
import static google.registry.util.MetricParameters.NAMESPACE_ID_ENV;
|
||||
import static google.registry.util.MetricParameters.POD_ID_ENV;
|
||||
import static google.registry.util.MetricParameters.PROJECT_ID_PATH;
|
||||
import static google.registry.util.MetricParameters.ZONE_PATH;
|
||||
import static java.nio.charset.StandardCharsets.UTF_8;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.anyInt;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import com.google.common.collect.ImmutableMap;
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.net.HttpURLConnection;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map.Entry;
|
||||
import java.util.function.Function;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/** Unit tests for {@link MetricParameters}. */
|
||||
class MetricParametersTest {
|
||||
|
||||
private static final HashMap<String, String> RESULTS = new HashMap<>();
|
||||
|
||||
private final HttpURLConnection projectIdConnection = mock(HttpURLConnection.class);
|
||||
private final HttpURLConnection clusterNameConnection = mock(HttpURLConnection.class);
|
||||
private final HttpURLConnection instanceIdConnection = mock(HttpURLConnection.class);
|
||||
private final HttpURLConnection zoneConnection = mock(HttpURLConnection.class);
|
||||
private final ImmutableMap<String, HttpURLConnection> mockConnections =
|
||||
ImmutableMap.of(
|
||||
PROJECT_ID_PATH,
|
||||
projectIdConnection,
|
||||
CLUSTER_NAME_PATH,
|
||||
clusterNameConnection,
|
||||
INSTANCE_ID_PATH,
|
||||
instanceIdConnection,
|
||||
ZONE_PATH,
|
||||
zoneConnection);
|
||||
private final HashMap<String, String> fakeEnvVarMap = new HashMap<>();
|
||||
private final Function<String, HttpURLConnection> fakeConnectionFactory = mockConnections::get;
|
||||
|
||||
private final MetricParameters metricParameters =
|
||||
new MetricParameters(fakeEnvVarMap, fakeConnectionFactory);
|
||||
|
||||
private static InputStream makeInputStreamFromString(String input) {
|
||||
return new ByteArrayInputStream(input.getBytes(UTF_8));
|
||||
}
|
||||
|
||||
@BeforeEach
|
||||
void beforeEach() throws Exception {
|
||||
fakeEnvVarMap.put(NAMESPACE_ID_ENV, "some-namespace");
|
||||
fakeEnvVarMap.put(POD_ID_ENV, "some-pod");
|
||||
fakeEnvVarMap.put(CONTAINER_NAME_ENV, "some-container");
|
||||
when(projectIdConnection.getInputStream())
|
||||
.thenReturn(makeInputStreamFromString("some-project"));
|
||||
when(clusterNameConnection.getInputStream())
|
||||
.thenReturn(makeInputStreamFromString("some-cluster"));
|
||||
when(instanceIdConnection.getInputStream())
|
||||
.thenReturn(makeInputStreamFromString("some-instance"));
|
||||
when(zoneConnection.getInputStream())
|
||||
.thenReturn(makeInputStreamFromString("projects/some-project/zones/some-zone"));
|
||||
for (Entry<String, HttpURLConnection> entry : mockConnections.entrySet()) {
|
||||
when(entry.getValue().getResponseCode()).thenReturn(200);
|
||||
}
|
||||
RESULTS.put("project_id", "some-project");
|
||||
RESULTS.put("cluster_name", "some-cluster");
|
||||
RESULTS.put("namespace_id", "some-namespace");
|
||||
RESULTS.put("instance_id", "some-instance");
|
||||
RESULTS.put("pod_id", "some-pod");
|
||||
RESULTS.put("container_name", "some-container");
|
||||
RESULTS.put("zone", "some-zone");
|
||||
}
|
||||
|
||||
@Test
|
||||
void testSuccess() {
|
||||
assertThat(metricParameters.makeLabelsMap()).isEqualTo(ImmutableMap.copyOf(RESULTS));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testSuccess_missingEnvVar() {
|
||||
fakeEnvVarMap.remove(POD_ID_ENV);
|
||||
RESULTS.put("pod_id", "");
|
||||
assertThat(metricParameters.makeLabelsMap()).isEqualTo(ImmutableMap.copyOf(RESULTS));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testSuccess_malformedZone() throws Exception {
|
||||
when(zoneConnection.getInputStream()).thenReturn(makeInputStreamFromString("some-zone"));
|
||||
RESULTS.put("zone", "");
|
||||
assertThat(metricParameters.makeLabelsMap()).isEqualTo(ImmutableMap.copyOf(RESULTS));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testSuccess_errorResponseCode() throws Exception {
|
||||
when(projectIdConnection.getResponseCode()).thenReturn(404);
|
||||
when(projectIdConnection.getErrorStream())
|
||||
.thenReturn(makeInputStreamFromString("some error message"));
|
||||
RESULTS.put("project_id", "");
|
||||
assertThat(metricParameters.makeLabelsMap()).isEqualTo(ImmutableMap.copyOf(RESULTS));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testSuccess_connectionError() throws Exception {
|
||||
InputStream fakeInputStream = mock(InputStream.class);
|
||||
when(projectIdConnection.getInputStream()).thenReturn(fakeInputStream);
|
||||
when(fakeInputStream.read(any(byte[].class), anyInt(), anyInt()))
|
||||
.thenThrow(new IOException("some exception"));
|
||||
RESULTS.put("project_id", "");
|
||||
assertThat(metricParameters.makeLabelsMap()).isEqualTo(ImmutableMap.copyOf(RESULTS));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user