mlbiscoc commented on code in PR #3413: URL: https://github.com/apache/solr/pull/3413#discussion_r2175578059
########## solr/core/src/java/org/apache/solr/metrics/otel/OtlpExporterFactory.java: ########## @@ -0,0 +1,65 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.solr.metrics.otel; + +import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter; +import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter; +import io.opentelemetry.sdk.metrics.export.MetricExporter; +import java.lang.invoke.MethodHandles; +import org.apache.solr.common.util.EnvUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Factory class for creating OpenTelemetry OTLP metric exporters and its configuration properties. + * + * @see io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter + * @see io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter + * @see NoopMetricExporter + */ +public class OtlpExporterFactory { Review Comment: It's debatable if this should be here in Core. Should we actually move this into the Open Telemetry module for the OTLP exporter? OTLP tracing exporter is enabled with module only so maybe metrics as well. ########## solr/core/src/java/org/apache/solr/metrics/SolrMetricManager.java: ########## @@ -723,10 +732,14 @@ public SdkMeterProvider meterProvider(String providerName) { providerName, key -> { var reader = new PrometheusMetricReader(true, null); - // NOCOMMIT: We need to add a Periodic Metric Reader here if we want to push with OTLP - // with an exporter - var provider = SdkMeterProvider.builder().registerMetricReader(reader).build(); - return new MeterProviderAndReaders(provider, reader); + var builder = + SdkMeterProvider.builder() + .registerMetricReader(reader) + .registerMetricReader( + PeriodicMetricReader.builder(metricExporter) + .setInterval(OTLP_EXPORTER_INTERVAL, TimeUnit.MILLISECONDS) + .build()); Review Comment: We are registering both the prometheus reader for our metrics endpoint and the periodic reader to push metrics to the OTLP exporter. ########## solr/core/src/java/org/apache/solr/metrics/otel/OtlpExporterFactory.java: ########## @@ -0,0 +1,65 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.solr.metrics.otel; + +import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter; +import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter; +import io.opentelemetry.sdk.metrics.export.MetricExporter; +import java.lang.invoke.MethodHandles; +import org.apache.solr.common.util.EnvUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Factory class for creating OpenTelemetry OTLP metric exporters and its configuration properties. + * + * @see io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter + * @see io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter + * @see NoopMetricExporter + */ +public class OtlpExporterFactory { + + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + + public static final Boolean OTLP_EXPORTER_ENABLED = + Boolean.parseBoolean(EnvUtils.getProperty("solr.otlpMetricExporterEnabled", "false")); + + public static final String OTLP_EXPORTER_PROTOCOL = + EnvUtils.getProperty("solr.otlpMetricExporterProtocol", "grpc"); + + public static final int OTLP_EXPORTER_INTERVAL = + Integer.parseInt(EnvUtils.getProperty("solr.otlpMetricExporterInterval", "60000")); Review Comment: 60 seconds is the default according to otel spec so copied it [here](https://opentelemetry.io/docs/specs/otel/metrics/sdk/#periodic-exporting-metricreader) but users can change the interval as they wish. ########## solr/core/src/java/org/apache/solr/metrics/otel/OtlpExporterFactory.java: ########## @@ -0,0 +1,65 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You 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 org.apache.solr.metrics.otel; + +import io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter; +import io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter; +import io.opentelemetry.sdk.metrics.export.MetricExporter; +import java.lang.invoke.MethodHandles; +import org.apache.solr.common.util.EnvUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Factory class for creating OpenTelemetry OTLP metric exporters and its configuration properties. + * + * @see io.opentelemetry.exporter.otlp.http.metrics.OtlpHttpMetricExporter + * @see io.opentelemetry.exporter.otlp.metrics.OtlpGrpcMetricExporter + * @see NoopMetricExporter + */ +public class OtlpExporterFactory { + + private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); + + public static final Boolean OTLP_EXPORTER_ENABLED = + Boolean.parseBoolean(EnvUtils.getProperty("solr.otlpMetricExporterEnabled", "false")); + + public static final String OTLP_EXPORTER_PROTOCOL = + EnvUtils.getProperty("solr.otlpMetricExporterProtocol", "grpc"); + + public static final int OTLP_EXPORTER_INTERVAL = + Integer.parseInt(EnvUtils.getProperty("solr.otlpMetricExporterInterval", "60000")); + + public static MetricExporter getExporter() { + if (!OTLP_EXPORTER_ENABLED) { + log.info("OTLP metric exporter is disabled."); + return new NoopMetricExporter(); + } + + return switch (OTLP_EXPORTER_PROTOCOL) { + case "grpc" -> OtlpGrpcMetricExporter.getDefault(); + case "http" -> OtlpHttpMetricExporter.getDefault(); Review Comment: Doing some testing, since we use the `getDefault` for both grpc and http, it actually reads some default env variables without us having to instrument our own read and configure for the exporter. For example, `OTEL_EXPORTER_OTLP_ENDPOINT` can change the endpoint where the metrics are pushed but I need to find all the different parameters that this picks up from documentation somewhere. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
