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

Jump to bottom

Improving metrics docs #382

Merged
merged 4 commits into from
Jul 13, 2023
Merged

Improving metrics docs #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
57749c2
JVMCBC-1338: db.couchbase.operations metric is exported differently t…
programmatix Jul 13, 2023
f2a17c2
em dash
RichardSmedley Jul 13, 2023
e99adf1
Gardening
RichardSmedley Jul 13, 2023
dbbf9f9
Merge branch 'release/3.4' into release/3.4
programmatix Jul 13, 2023
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
78 changes: 56 additions & 22 deletions modules/howtos/examples/Metrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,43 +1,77 @@
import java.time.Duration;

import com.couchbase.client.core.env.CoreEnvironment;
import com.couchbase.client.core.env.LoggingMeterConfig;
import com.couchbase.client.java.Cluster;
import com.couchbase.client.java.ClusterOptions;
import com.couchbase.client.java.env.ClusterEnvironment;
import com.couchbase.client.java.json.JsonObject;
import com.couchbase.client.metrics.opentelemetry.OpenTelemetryMeter;

import io.opentelemetry.api.metrics.Meter;
import io.opentelemetry.exporter.prometheus.PrometheusCollector;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.metrics.MeterSdkProvider;
import io.prometheus.client.exporter.HTTPServer;
import io.opentelemetry.sdk.metrics.*;
import io.opentelemetry.sdk.metrics.export.MetricExporter;
import io.opentelemetry.sdk.metrics.export.PeriodicMetricReader;
import io.opentelemetry.sdk.resources.Resource;

import java.time.Duration;
import java.util.List;

public class Metrics {
public static void main(String... args) throws Exception {

{
// tag::metrics-enable-custom[]
CoreEnvironment environment = CoreEnvironment.builder()
.loggingMeterConfig(LoggingMeterConfig.enabled(true).emitInterval(Duration.ofSeconds(30))).build();
ClusterEnvironment environment = ClusterEnvironment.builder()
.loggingMeterConfig(config -> config.enabled(true).emitInterval(Duration.ofSeconds(30)))
.build();
// end::metrics-enable-custom[]
}

{
String hostname = "localhost";
String username = "Administrator";
String password = "password";

// tag::metrics-otel-prometheus[]
// Build the OpenTelemetry Meter
MeterSdkProvider meterSdkProvider = OpenTelemetrySdk.getGlobalMeterProvider();
Meter meter = meterSdkProvider.get("OpenTelemetryMetricsSample");
// Setup an exporter.
// This exporter exports traces on the OTLP protocol over GRPC to localhost:4317.
MetricExporter exporter = OtlpGrpcMetricExporter.builder()
.setCompression("gzip")
.setEndpoint("http://localhost:4317")
.build();

// Start the Prometheus HTTP Server
HTTPServer server = server = new HTTPServer(19090);
// Create the OpenTelemetry SDK's SdkMeterProvider.
SdkMeterProvider sdkMeterProvider = SdkMeterProvider.builder()
.setResource(Resource.getDefault()
.merge(Resource.builder()
// An OpenTelemetry service name generally reflects the name of your microservice,
// e.g. "shopping-cart-service".
.put("service.name", "YOUR_SERVICE_NAME_HERE")
.build()))
// Operation durations are in nanoseconds, which are too large for the default OpenTelemetry histogram buckets.
.registerView(InstrumentSelector.builder().setType(InstrumentType.HISTOGRAM).build(),
View.builder().setAggregation(Aggregation.explicitBucketHistogram(List.of(
100000.0,
250000.0,
500000.0,
1000000.0,
10000000.0,
100000000.0,
1000000000.0,
10000000000.0))).build())
.registerMetricReader(PeriodicMetricReader.builder(exporter).setInterval(Duration.ofSeconds(1)).build())
.build();

// Register the Prometheus Collector
PrometheusCollector.builder().setMetricProducer(meterSdkProvider.getMetricProducer()).buildAndRegister();
// Create the OpenTelemetry SDK's OpenTelemetry object.
OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
.setMeterProvider(sdkMeterProvider)
.buildAndRegisterGlobal();

// Provide the OpenTelemetry object as part of the Cluster configuration.
Cluster cluster = Cluster.connect(hostname, ClusterOptions.clusterOptions(username, password)
.environment(env -> env.meter(OpenTelemetryMeter.wrap(openTelemetry))));
// end::metrics-otel-prometheus[]

// tag::metrics-otel-env[]
ClusterEnvironment environment = ClusterEnvironment.builder().meter(OpenTelemetryMeter.wrap(meter)).build();
// end::metrics-otel-env[]
// A basic test to check the metrics are exporting.
cluster.bucket("default").defaultCollection().upsert("doc", JsonObject.create());
}

}
}
56 changes: 56 additions & 0 deletions modules/howtos/examples/MetricsMicrometer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import com.couchbase.client.core.error.TimeoutException;
import com.couchbase.client.java.Cluster;
import com.couchbase.client.java.ClusterOptions;
import com.couchbase.client.java.json.JsonObject;
import com.couchbase.client.metrics.micrometer.MicrometerMeter;
import io.micrometer.core.instrument.Meter;
import io.micrometer.core.instrument.config.MeterFilter;
import io.micrometer.core.instrument.distribution.DistributionStatisticConfig;
import io.micrometer.prometheus.PrometheusConfig;
import io.micrometer.prometheus.PrometheusMeterRegistry;
import io.prometheus.client.exporter.HTTPServer;

import java.net.InetSocketAddress;

public class MetricsMicrometer {
public static void main(String... args) throws Exception {

String hostname = "localhost";
String username = "Administrator";
String password = "password";

// tag::metrics-micrometer-prometheus[]
PrometheusMeterRegistry prometheusRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);

// Micrometer won't create a histogram by default, configure that.
prometheusRegistry.config().meterFilter(
new MeterFilter() {
@Override
public DistributionStatisticConfig configure(Meter.Id id, DistributionStatisticConfig config) {
if (id.getType() == Meter.Type.DISTRIBUTION_SUMMARY) {
return DistributionStatisticConfig.builder()
.percentilesHistogram(true)
.build()
.merge(config);
}
return config;
}
});

// Setup an HTTP server running on port 10000 that Prometheus can scrape for Micrometer metrics.
new HTTPServer(new InetSocketAddress(10000), prometheusRegistry.getPrometheusRegistry(), true);

// Provide the Micrometer registry as part of the Cluster configuration.
Cluster cluster = Cluster.connect(hostname, ClusterOptions.clusterOptions(username, password)
.environment(env -> env.meter(MicrometerMeter.wrap(prometheusRegistry))));
// end::metrics-micrometer-prometheus[]

while (true) {
try {
// A basic test to check the metrics are exporting.
cluster.bucket("default").defaultCollection().upsert("doc", JsonObject.create());
} catch (TimeoutException err) {
}
}
}
}
4 changes: 2 additions & 2 deletions modules/howtos/examples/Tracing.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ public static void opentelemetryDirect() {
.put("service.name", "YOUR_SERVICE_NAME_HERE")
.build()))
// The BatchSpanProcessor will efficiently batch traces and periodically export them.
// This exporter exports traces on the OTLP protocol over GRPC on port 4317.
// This exporter exports traces on the OTLP protocol over GRPC to localhost:4317.
.addSpanProcessor(BatchSpanProcessor.builder(OtlpGrpcSpanExporter.builder()
.setEndpoint("HOSTNAME_OF_OPENTELEMETRY_BACKEND:4317")
.setEndpoint("http://localhost:4317")
.build()).build())
// Export every trace: this may be too heavy for production.
// An alternative is `.setSampler(Sampler.traceIdRatioBased(0.01))`
Expand Down
15 changes: 2 additions & 13 deletions modules/howtos/examples/TransactionsExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,10 @@

// tag::imports[]

import com.couchbase.client.core.cnc.events.transaction.TransactionLogEvent;
import com.couchbase.client.core.cnc.events.transaction.*;
import com.couchbase.client.core.error.CouchbaseException;
import com.couchbase.client.core.error.DocumentNotFoundException;
import com.couchbase.client.core.msg.kv.DurabilityLevel;
import com.couchbase.client.core.transactions.events.IllegalDocumentStateEvent;
import com.couchbase.client.core.transactions.events.TransactionCleanupAttemptEvent;
import com.couchbase.client.core.transactions.events.TransactionCleanupEndRunEvent;
import com.couchbase.client.core.transactions.events.TransactionEvent;
import com.couchbase.client.core.transactions.log.CoreTransactionLogMessage;
import com.couchbase.client.java.Bucket;
import com.couchbase.client.java.Cluster;
import com.couchbase.client.java.ClusterOptions;
Expand All @@ -43,7 +38,6 @@
import com.couchbase.client.java.transactions.config.TransactionsQueryConfig;
import com.couchbase.client.java.transactions.error.TransactionCommitAmbiguousException;
import com.couchbase.client.java.transactions.error.TransactionFailedException;
import com.couchbase.client.java.transactions.log.TransactionLogMessage;
import com.couchbase.client.tracing.opentelemetry.OpenTelemetryRequestSpan;
import io.opentelemetry.api.trace.Span;
import reactor.core.publisher.Flux;
Expand Down Expand Up @@ -424,21 +418,16 @@ static void concurrency() {
cluster.environment().eventBus().subscribe(event -> {
if (event instanceof IllegalDocumentStateEvent) {
// log this event for review
log(((TransactionEvent) event).logs());
}
});
// end::concurrency[]
}

private static void log(List<CoreTransactionLogMessage> logs) {
// Application can write to their logs here
}

static void cleanupEvents() {
// tag::cleanup-events[]
cluster.environment().eventBus().subscribe(event -> {
if (event instanceof TransactionCleanupAttemptEvent || event instanceof TransactionCleanupEndRunEvent) {
log(((TransactionEvent) event).logs());
// log event for review
}
});
// end::cleanup-events[]
Expand Down
Loading
Loading