content: /*
   * 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.kafka.streams.internals.metrics;
  
  import org.apache.kafka.common.metrics.Gauge;
  import org.apache.kafka.common.metrics.Sensor;
  import org.apache.kafka.common.metrics.Sensor.RecordingLevel;
  import org.apache.kafka.streams.KafkaStreams.State;
  import org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl;
  
  import org.junit.jupiter.api.Test;
  
  import java.util.Collections;
  import java.util.Map;
  
  import static org.apache.kafka.streams.processor.internals.metrics.StreamsMetricsImpl.CLIENT_LEVEL_GROUP;
  import static org.hamcrest.CoreMatchers.is;
  import static org.hamcrest.MatcherAssert.assertThat;
  import static org.mockito.Mockito.eq;
  import static org.mockito.Mockito.mock;
  import static org.mockito.Mockito.verify;
  import static org.mockito.Mockito.when;
  
  public class ClientMetricsTest {
      private static final String COMMIT_ID = "test-commit-ID";
      private static final String VERSION = "test-version";
  
      private final StreamsMetricsImpl streamsMetrics = mock(StreamsMetricsImpl.class);
      private final Sensor expectedSensor = mock(Sensor.class);
      private final Map<String, String> tagMap = Collections.singletonMap("hello", "world");
  
  
      @Test
      public void shouldAddVersionMetric() {
          final String name = "version";
          final String description = "The version of the Kafka Streams client";
          setUpAndVerifyImmutableMetric(name, description, VERSION, () -> ClientMetrics.addVersionMetric(streamsMetrics));
      }
  
      @Test
      public void shouldAddCommitIdMetric() {
          final String name = "commit-id";
          final String description = "The version control commit ID of the Kafka Streams client";
          setUpAndVerifyImmutableMetric(name, description, COMMIT_ID, () -> ClientMetrics.addCommitIdMetric(streamsMetrics));
      }
  
      @Test
      public void shouldAddApplicationIdMetric() {
          final String name = "application-id";
          final String description = "The application ID of the Kafka Streams client";
          final String applicationId = "thisIsAnID";
          setUpAndVerifyImmutableMetric(
              name,
              description,
              applicationId,
              () -> ClientMetrics.addApplicationIdMetric(streamsMetrics, applicationId)
          );
      }
  
      @Test
      public void shouldAddTopologyDescriptionMetric() {
          final String name = "topology-description";
          final String description = "The description of the topology executed in the Kafka Streams client";
          final String topologyDescription = "thisIsATopologyDescription";
          final Gauge<String> topologyDescriptionProvider = (c, n) -> topologyDescription;
          setUpAndVerifyMutableMetric(
              name,
              description,
              topologyDescriptionProvider,
              () -> ClientMetrics.addTopologyDescriptionMetric(streamsMetrics, topologyDescriptionProvider)
          );
      }
  
      @Test
      public void shouldAddStateMetric() {
          final String name = "state";
          final String description = "The state of the Kafka Streams client";
          final Gauge<String> stateProvider = (config, now) -> State.RUNNING.name();
          setUpAndVerifyMutableMetric(
              name,
              description,
              stateProvider,
              () -> ClientMetrics.addStateMetric(streamsMetrics, stateProvider)
          );
      }
  
      @Test
      public void shouldAddAliveStreamThreadsMetric() {
          final String name = "alive-stream-threads";
          final String description = "The current number of alive stream threads that are running or participating in rebalance";
          final Gauge<Integer> valueProvider = (config, now) -> 1;
          setUpAndVerifyMutableMetric(
              name,
              description,
              valueProvider,
              () -> ClientMetrics.addNumAliveStreamThreadMetric(streamsMetrics, valueProvider)
          );
      }
  
      @Test
      public void shouldAddClientStateTelemetryMetric() {
          final String name = "client-state";
          final String description = "The state of the Kafka Streams client";
          final Gauge<Integer> stateProvider = (config, now) -> State.RUNNING.ordinal();
          setUpAndVerifyMutableMetric(
                  name,
                  description,
                  stateProvider,
                  () -> ClientMetrics.addClientStateTelemetryMetric(streamsMetrics, stateProvider)
          );
      }
  
      @Test
      public void shouldAddRecordingLevelMetric() {
          final String name = "recording-level";
          final String description = "The metrics recording level of the Kafka Streams client";
          final int recordingLevel = 1;
          setUpAndVerifyImmutableMetric(
                  name,
                  description,
                  recordingLevel,
                  () -> ClientMetrics.addClientRecordingLevelMetric(streamsMetrics, recordingLevel)
          );
      }
  
      @Test
      public void shouldGetFailedStreamThreadsSensor() {
          final String name = "failed-stream-threads";
          final String description = "The number of failed stream threads since the start of the Kafka Streams client";
          when(streamsMetrics.clientLevelSensor(name, RecordingLevel.INFO)).thenReturn(expectedSensor);
          when(streamsMetrics.clientLevelTagMap()).thenReturn(tagMap);
          StreamsMetricsImpl.addSumMetricToSensor(
              expectedSensor,
              CLIENT_LEVEL_GROUP,
              tagMap,
              name,
              false,
              description
          );
  
          final Sensor sensor = ClientMetrics.failedStreamThreadSensor(streamsMetrics);
          assertThat(sensor, is(expectedSensor));
      }
  
      private <K> void setUpAndVerifyMutableMetric(final String name,
                                                   final String description,
                                                   final Gauge<K> valueProvider,
                                                   final Runnable metricAdder) {
  
          metricAdder.run();
  
          verify(streamsMetrics).addClientLevelMutableMetric(
                  eq(name),
                  eq(description),
                  eq(RecordingLevel.INFO),
                  eq(valueProvider)
          );
      }
  
      private void setUpAndVerifyImmutableMetric(final String name,
                                                 final String description,
                                                 final String value,
                                                 final Runnable metricAdder) {
  
          metricAdder.run();
  
          verify(streamsMetrics).addClientLevelImmutableMetric(
                  eq(name),
                  eq(description),
                  eq(RecordingLevel.INFO),
                  eq(value)
          );
      }
  
      private void setUpAndVerifyImmutableMetric(final String name,
                                                 final String description,
                                                 final int value,
                                                 final Runnable metricAdder) {
  
          metricAdder.run();
  
          verify(streamsMetrics).addClientLevelImmutableMetric(
                  eq(name),
                  eq(description),
                  eq(RecordingLevel.INFO),
                  eq(value)
          );
      }
  }