diff --git a/monitoring/cloud-client/src/main/java/com/example/monitoring/Snippets.java b/monitoring/cloud-client/src/main/java/com/example/monitoring/Snippets.java new file mode 100644 index 00000000000..217f9fa9017 --- /dev/null +++ b/monitoring/cloud-client/src/main/java/com/example/monitoring/Snippets.java @@ -0,0 +1,592 @@ +/* + * Copyright 2016 Google Inc. 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 com.example.monitoring; + +import com.google.api.Metric; +import com.google.api.MetricDescriptor; +import com.google.api.MonitoredResource; +import com.google.api.MonitoredResourceDescriptor; +import com.google.cloud.monitoring.spi.v3.MetricServiceClient; +import com.google.cloud.monitoring.spi.v3.PagedResponseWrappers; +import com.google.monitoring.v3.Aggregation; +import com.google.monitoring.v3.CreateMetricDescriptorRequest; +import com.google.monitoring.v3.CreateTimeSeriesRequest; +import com.google.monitoring.v3.ListMetricDescriptorsRequest; +import com.google.monitoring.v3.ListMonitoredResourceDescriptorsRequest; +import com.google.monitoring.v3.ListTimeSeriesRequest; +import com.google.monitoring.v3.MetricDescriptorName; +import com.google.monitoring.v3.MonitoredResourceDescriptorName; +import com.google.monitoring.v3.Point; +import com.google.monitoring.v3.ProjectName; +import com.google.monitoring.v3.TimeInterval; +import com.google.monitoring.v3.TimeSeries; +import com.google.monitoring.v3.TypedValue; +import com.google.protobuf.Duration; +import com.google.protobuf.util.Timestamps; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +// Imports the Google Cloud client library + + +public class Snippets { + + private static final String CUSTOM_METRIC_DOMAIN = "custom.googleapis.com"; + + /** + * Exercises the methods defined in this class. + * + *

Assumes that you are authenticated using the Google Cloud SDK (using + * {@code gcloud auth application-default-login}). + */ + public static void main(String[] args) throws Exception { + + Snippets snippets = new Snippets(); + System.out.println("Stackdriver Monitoring snippets"); + System.out.println(); + printUsage(); + while (true) { + String commandLine = System.console().readLine("> "); + if (commandLine.trim().isEmpty()) { + break; + } + try { + snippets.handleCommandLine(commandLine); + } catch (IllegalArgumentException e) { + System.out.println(e.getMessage()); + printUsage(); + } + } + System.out.println("exiting"); + System.exit(0); + } + + /** + * Creates a metric descriptor. + * + * See: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors/create + * @param type The metric type + */ + void createMetricDescriptor(String type) throws IOException { + // [START monitoring_create_metric] + // Your Google Cloud Platform project ID + String projectId = System.getProperty("projectId"); + String metricType = CUSTOM_METRIC_DOMAIN + "/" + type; + + final MetricServiceClient client = MetricServiceClient.create(); + ProjectName name = ProjectName.create(projectId); + + MetricDescriptor descriptor = MetricDescriptor.newBuilder() + .setType(metricType) + .setDescription("This is a simple example of a custom metric.") + .setMetricKind(MetricDescriptor.MetricKind.GAUGE) + .setValueType(MetricDescriptor.ValueType.DOUBLE) + .build(); + + CreateMetricDescriptorRequest request = CreateMetricDescriptorRequest.newBuilder() + .setNameWithProjectName(name) + .setMetricDescriptor(descriptor) + .build(); + + client.createMetricDescriptor(request); + // [END monitoring_create_metric] + } + + /** + * Delete a metric descriptor. + * @param name Name of metric descriptor to delete + */ + void deleteMetricDescriptor(String name) throws IOException { + String projectId = System.getProperty("projectId"); + final MetricServiceClient client = MetricServiceClient.create(); + MetricDescriptorName metricName = MetricDescriptorName.create(projectId, name); + client.deleteMetricDescriptor(metricName); + System.out.println("Deleted descriptor " + name); + } + + /** + * Demonstrates writing a time series value for the metric type + * 'custom.google.apis.com/my_metric'. + * + * This method assumes `my_metric` descriptor has already been created as a + * DOUBLE value_type and GAUGE metric kind. If the metric descriptor + * doesn't exist, it will be auto-created. + * + */ + void writeTimeSeries() throws IOException { + // [START monitoring_write_timeseries] + String projectId = System.getProperty("projectId"); + // Instantiates a client + MetricServiceClient metricServiceClient = MetricServiceClient.create(); + + // Prepares an individual data point + TimeInterval interval = TimeInterval.newBuilder() + .setEndTime(Timestamps.fromMillis(System.currentTimeMillis())) + .build(); + TypedValue value = TypedValue.newBuilder() + .setDoubleValue(123.45) + .build(); + Point point = Point.newBuilder() + .setInterval(interval) + .setValue(value) + .build(); + + List pointList = new ArrayList<>(); + pointList.add(point); + + ProjectName name = ProjectName.create(projectId); + + // Prepares the metric descriptor + Map metricLabels = new HashMap(); + Metric metric = Metric.newBuilder() + .setType("custom.googleapis.com/my_metric") + .putAllLabels(metricLabels) + .build(); + + // Prepares the monitored resource descriptor + Map resourceLabels = new HashMap(); + resourceLabels.put("instance_id", "1234567890123456789"); + resourceLabels.put("zone", "us-central1-f"); + + MonitoredResource resource = MonitoredResource.newBuilder() + .setType("gce_instance") + .putAllLabels(resourceLabels) + .build(); + + // Prepares the time series request + TimeSeries timeSeries = TimeSeries.newBuilder() + .setMetric(metric) + .setResource(resource) + .addAllPoints(pointList) + .build(); + + List timeSeriesList = new ArrayList<>(); + timeSeriesList.add(timeSeries); + + CreateTimeSeriesRequest request = CreateTimeSeriesRequest.newBuilder() + .setNameWithProjectName(name) + .addAllTimeSeries(timeSeriesList) + .build(); + + // Writes time series data + metricServiceClient.createTimeSeries(request); + System.out.println("Done writing time series value."); + // [END monitoring_write_timeseries] + } + + /** + * Demonstrates listing time series headers. + */ + void listTimeSeriesHeaders() throws IOException { + // [START monitoring_read_timeseries_fields] + MetricServiceClient metricServiceClient = MetricServiceClient.create(); + String projectId = System.getProperty("projectId"); + ProjectName name = ProjectName.create(projectId); + + + // Restrict time to last 20 minutes + long startMillis = System.currentTimeMillis() - ((60 * 20) * 1000); + TimeInterval interval = TimeInterval.newBuilder() + .setStartTime(Timestamps.fromMillis(startMillis)) + .setEndTime(Timestamps.fromMillis(System.currentTimeMillis())) + .build(); + + ListTimeSeriesRequest.Builder requestBuilder = ListTimeSeriesRequest.newBuilder() + .setNameWithProjectName(name) + .setFilter("metric.type=\"compute.googleapis.com/instance/cpu/utilization\"") + .setInterval(interval) + .setView(ListTimeSeriesRequest.TimeSeriesView.HEADERS); + + String nextToken = ""; + + do { + if (nextToken != null) { + requestBuilder.setPageToken(nextToken); + } + ListTimeSeriesRequest request = requestBuilder.build(); + + PagedResponseWrappers.ListTimeSeriesPagedResponse response = metricServiceClient + .listTimeSeries(request); + List timeseries = response.getPage() + .getResponseObject() + .getTimeSeriesList(); + + System.out.println("Got timeseries headers: "); + for (TimeSeries ts : timeseries) { + System.out.println(ts); + } + Object nextObjectToken = response.getNextPageToken(); + nextToken = (String)nextObjectToken; + } while (nextToken != ""); + // [END monitoring_read_timeseries_fields] + } + + /** + * Demonstrates listing time series using a filter. + * + */ + void listTimeSeries(String filter) throws IOException { + // [START monitoring_read_timeseries_simple] + MetricServiceClient metricServiceClient = MetricServiceClient.create(); + String projectId = System.getProperty("projectId"); + ProjectName name = ProjectName.create(projectId); + + + // Restrict time to last 20 minutes + long startMillis = System.currentTimeMillis() - ((60 * 20) * 1000); + TimeInterval interval = TimeInterval.newBuilder() + .setStartTime(Timestamps.fromMillis(startMillis)) + .setEndTime(Timestamps.fromMillis(System.currentTimeMillis())) + .build(); + + ListTimeSeriesRequest.Builder requestBuilder = ListTimeSeriesRequest.newBuilder() + .setNameWithProjectName(name) + .setFilter(filter) + .setInterval(interval); + + String nextToken = ""; + + do { + if (nextToken != null) { + requestBuilder.setPageToken(nextToken); + } + ListTimeSeriesRequest request = requestBuilder.build(); + + PagedResponseWrappers.ListTimeSeriesPagedResponse response = metricServiceClient + .listTimeSeries(request); + List timeseries = response.getPage() + .getResponseObject() + .getTimeSeriesList(); + + System.out.println("Got timeseries: "); + for (TimeSeries ts : timeseries) { + System.out.println(ts); + } + Object nextObjectToken = response.getNextPageToken(); + nextToken = (String)nextObjectToken; + } while (nextToken != ""); + // [END monitoring_read_timeseries_simple] + } + + /** + * Demonstrates listing time series and aggregating them. + * + */ + void listTimeSeriesAggregrate() throws IOException { + // [START monitoring_read_timeseries_align] + MetricServiceClient metricServiceClient = MetricServiceClient.create(); + String projectId = System.getProperty("projectId"); + ProjectName name = ProjectName.create(projectId); + + + // Restrict time to last 20 minutes + long startMillis = System.currentTimeMillis() - ((60 * 20) * 1000); + TimeInterval interval = TimeInterval.newBuilder() + .setStartTime(Timestamps.fromMillis(startMillis)) + .setEndTime(Timestamps.fromMillis(System.currentTimeMillis())) + .build(); + + Aggregation aggregation = Aggregation.newBuilder() + .setAlignmentPeriod(Duration.newBuilder().setSeconds(600).build()) + .setPerSeriesAligner(Aggregation.Aligner.ALIGN_MEAN) + .build(); + + ListTimeSeriesRequest.Builder requestBuilder = ListTimeSeriesRequest.newBuilder() + .setNameWithProjectName(name) + .setFilter("metric.type=\"compute.googleapis.com/instance/cpu/utilization\"") + .setInterval(interval) + .setAggregation(aggregation); + + String nextToken = ""; + do { + if (nextToken != null) { + requestBuilder.setPageToken(nextToken); + } + ListTimeSeriesRequest request = requestBuilder.build(); + + PagedResponseWrappers.ListTimeSeriesPagedResponse response = metricServiceClient + .listTimeSeries(request); + List timeseries = response.getPage() + .getResponseObject() + .getTimeSeriesList(); + + System.out.println("Got timeseries: "); + for (TimeSeries ts : timeseries) { + System.out.println(ts); + } + Object nextObjectToken = response.getNextPageToken(); + nextToken = (String)nextObjectToken; + } while (nextToken != ""); + // [END monitoring_read_timeseries_align] + } + + /** + * Demonstrates listing time series and aggregating and reducing them. + * + */ + void listTimeSeriesReduce() throws IOException { + // [START monitoring_read_timeseries_reduce] + MetricServiceClient metricServiceClient = MetricServiceClient.create(); + String projectId = System.getProperty("projectId"); + ProjectName name = ProjectName.create(projectId); + + + // Restrict time to last 20 minutes + long startMillis = System.currentTimeMillis() - ((60 * 20) * 1000); + TimeInterval interval = TimeInterval.newBuilder() + .setStartTime(Timestamps.fromMillis(startMillis)) + .setEndTime(Timestamps.fromMillis(System.currentTimeMillis())) + .build(); + + Aggregation aggregation = Aggregation.newBuilder() + .setAlignmentPeriod(Duration.newBuilder().setSeconds(600).build()) + .setPerSeriesAligner(Aggregation.Aligner.ALIGN_MEAN) + .setCrossSeriesReducer(Aggregation.Reducer.REDUCE_MEAN) + .build(); + + ListTimeSeriesRequest.Builder requestBuilder = ListTimeSeriesRequest.newBuilder() + .setNameWithProjectName(name) + .setFilter("metric.type=\"compute.googleapis.com/instance/cpu/utilization\"") + .setInterval(interval) + .setAggregation(aggregation); + + String nextToken = ""; + + do { + if (nextToken != null) { + requestBuilder.setPageToken(nextToken); + } + ListTimeSeriesRequest request = requestBuilder.build(); + + PagedResponseWrappers.ListTimeSeriesPagedResponse response = metricServiceClient + .listTimeSeries(request); + List timeseries = response.getPage() + .getResponseObject() + .getTimeSeriesList(); + + System.out.println("Got timeseries: "); + for (TimeSeries ts : timeseries) { + System.out.println(ts); + } + Object nextObjectToken = response.getNextPageToken(); + nextToken = (String)nextObjectToken; + } while (nextToken != ""); + // [END monitoring_read_timeseries_reduce] + } + + /** + * Returns the first page of all metric descriptors. + */ + void listMetricDescriptors() throws IOException { + // [START monitoring_list_descriptors] + // Your Google Cloud Platform project ID + String projectId = System.getProperty("projectId"); + + final MetricServiceClient client = MetricServiceClient.create(); + ProjectName name = ProjectName.create(projectId); + + ListMetricDescriptorsRequest request = ListMetricDescriptorsRequest + .newBuilder() + .setNameWithProjectName(name) + .build(); + PagedResponseWrappers.ListMetricDescriptorsPagedResponse response = + client.listMetricDescriptors(request); + + System.out.println("Listing descriptors: "); + + List descriptors = response.getPage() + .getResponseObject().getMetricDescriptorsList(); + for (MetricDescriptor d : descriptors) { + System.out.println(d.getName() + " " + d.getDisplayName()); + } + // [END monitoring_list_descriptors] + } + + /** + * Gets all monitored resource descriptors. + */ + void listMonitoredResources() throws IOException { + // [START monitoring_list_resources] + // Your Google Cloud Platform project ID + String projectId = System.getProperty("projectId"); + + final MetricServiceClient client = MetricServiceClient.create(); + ProjectName name = ProjectName.create(projectId); + + ListMonitoredResourceDescriptorsRequest request = ListMonitoredResourceDescriptorsRequest + .newBuilder() + .setNameWithProjectName(name) + .build(); + + System.out.println("Listing monitored resource descriptors: "); + + PagedResponseWrappers.ListMonitoredResourceDescriptorsPagedResponse response = client + .listMonitoredResourceDescriptors(request); + + List descriptors = response.getPage() + .getResponseObject().getResourceDescriptorsList(); + + for (MonitoredResourceDescriptor d : descriptors) { + System.out.println(d.getType()); + } + // [START monitoring_list_resources] + } + + /** + * Gets full information for a monitored resource. + * @param The resource type + */ + void describeMonitoredResources(String type) throws IOException { + // [START monitoring_list_resources] + // Your Google Cloud Platform project ID + String projectId = System.getProperty("projectId"); + + final MetricServiceClient client = MetricServiceClient.create(); + MonitoredResourceDescriptorName name = MonitoredResourceDescriptorName.create(projectId, type); + MonitoredResourceDescriptor response = client.getMonitoredResourceDescriptor(name); + + System.out.println("Printing monitored resource descriptor: "); + System.out.println(response); + + // [END monitoring_list_resources] + } + + + /** + * Handles a single command. + * + * @param commandLine A line of input provided by the user + */ + void handleCommandLine(String commandLine) throws IOException { + String[] args = commandLine.split("\\s+"); + + if (args.length < 1) { + throw new IllegalArgumentException("not enough args"); + } + + String command = args[0]; + switch (command) { + case "new-metric-descriptor": + // Everything after the first whitespace token is interpreted to be the description. + args = commandLine.split("\\s+", 2); + if (args.length != 2) { + throw new IllegalArgumentException("usage: "); + } + // Set created to now() and done to false. + createMetricDescriptor(args[1]); + System.out.println("Metric descriptor created"); + break; + case "list-metric-descriptors": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: no arguments"); + } + listMetricDescriptors(); + break; + case "list-monitored-resources": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: no arguments"); + } + listMonitoredResources(); + break; + case "get-resource": + args = commandLine.split("\\s+", 2); + if (args.length != 2) { + throw new IllegalArgumentException("usage: "); + } + describeMonitoredResources(args[1]); + break; + case "delete-metric-descriptor": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: "); + } + deleteMetricDescriptor(args[1]); + break; + case "write-time-series": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: no arguments"); + } + writeTimeSeries(); + break; + case "list-time-series-header": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: no arguments"); + } + listTimeSeriesHeaders(); + break; + case "list-time-series": + args = commandLine.split("\\s+", 2); + if (args.length != 2) { + throw new IllegalArgumentException("usage: "); + } + listTimeSeries(args[1]); + break; + case "list-aggregate": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: no arguments"); + } + listTimeSeriesAggregrate(); + break; + case "list-reduce": + args = commandLine.split("\\s+", 2); + if (args.length != 1) { + throw new IllegalArgumentException("usage: no arguments"); + } + listTimeSeriesReduce(); + break; + default: + throw new IllegalArgumentException("unrecognized command: " + command); + } + } + + private void assertArgsLength(String[] args, int expectedLength) { + if (args.length != expectedLength) { + throw new IllegalArgumentException( + String.format("expected exactly %d arg(s), found %d", expectedLength, args.length)); + } + } + + private static void printUsage() { + System.out.println("Usage:"); + System.out.println(); + System.out.println(" new-metric-descriptor Creates a metric descriptor"); + System.out.println(" list-metric-descriptors Lists first page of metric descriptors"); + System.out.println(" list-monitored-resources Lists the monitored resources"); + System.out.println(" get-resource Describes a monitored resource"); + System.out.println(" delete-metric-descriptors Deletes a metric descriptor"); + System.out.println(" write-time-series Writes a time series value to a metric"); + System.out.println(" list-headers List time series header of " + + " 'compute.googleapis.com/instance/cpu/utilization'"); + System.out.println(" list-time-series-header List time series data that matches a " + + "given filter"); + System.out.println(" list-aggregate `Aggregates time series data that matches" + + "'compute.googleapis.com/instance/cpu/utilization"); + System.out.println(" list-reduce `Reduces time series data that matches" + + " 'compute.googleapis.com/instance/cpu/utilization"); + System.out.println(); + } + +} diff --git a/monitoring/cloud-client/src/test/java/com/example/monitoring/SnippetsIT.java b/monitoring/cloud-client/src/test/java/com/example/monitoring/SnippetsIT.java new file mode 100644 index 00000000000..bb06947fda9 --- /dev/null +++ b/monitoring/cloud-client/src/test/java/com/example/monitoring/SnippetsIT.java @@ -0,0 +1,151 @@ +/* + Copyright 2016, Google, Inc. + + 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 com.example.monitoring; + +import static com.google.common.truth.Truth.assertThat; + +import org.junit.After; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.junit.runners.JUnit4; + +import java.io.ByteArrayOutputStream; +import java.io.PrintStream; + +/** + * Tests for quickstart sample. + */ +@RunWith(JUnit4.class) +@SuppressWarnings("checkstyle:abbreviationaswordinname") +public class SnippetsIT { + private ByteArrayOutputStream bout; + private PrintStream out; + private static final String LEGACY_PROJECT_ENV_NAME = "GCLOUD_PROJECT"; + private static final String PROJECT_ENV_NAME = "GOOGLE_CLOUD_PROJECT"; + + private static String getProjectId() { + String projectId = System.getProperty(PROJECT_ENV_NAME, System.getenv(PROJECT_ENV_NAME)); + if (projectId == null) { + projectId = System.getProperty(LEGACY_PROJECT_ENV_NAME, + System.getenv(LEGACY_PROJECT_ENV_NAME)); + } + return projectId; + } + + @Before + public void setUp() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + System.setOut(null); + } + + @Test + public void testListMetricsDescriptor() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.listMetricDescriptors(); + // Assert + String got = bout.toString(); + assertThat(got).contains("metricDescriptors/bigquery.googleapis.com/query/count"); + } + + @Test + public void testListTimeSeries() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.listTimeSeries("metric.type=\"compute.googleapis.com/instance/cpu/utilization\""); + + // Assert + String got = bout.toString(); + assertThat(got).contains("Got timeseries:"); + } + + @Test + public void testListTimeSeriesHeader() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.listTimeSeriesHeaders(); + + // Assert + String got = bout.toString(); + assertThat(got).contains("Got timeseries headers:"); + } + + @Test + public void testListTimeSeriesAggregate() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.listTimeSeriesAggregrate(); + + // Assert + String got = bout.toString(); + assertThat(got).contains("Got timeseries:"); + } + + @Test + public void testListTimeSeriesReduce() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.listTimeSeriesReduce(); + + // Assert + String got = bout.toString(); + assertThat(got).contains("Got timeseries:"); + } + + @Test + public void testGetResource() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.describeMonitoredResources("cloudsql_database"); + + // Assert + String got = bout.toString(); + assertThat(got).contains("\"A database hosted in Google Cloud SQL"); + } + + @Test + public void testListResources() throws Exception { + // Act + System.setProperty("projectId", SnippetsIT.getProjectId()); + Snippets snippets = new Snippets(); + + snippets.listMonitoredResources(); + + // Assert + String got = bout.toString(); + assertThat(got).contains("gce_instance"); + } +}