001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client.trace.hamcrest;
019
020import static org.apache.hadoop.hbase.client.trace.hamcrest.AttributesMatchers.containsEntry;
021import static org.apache.hadoop.hbase.client.trace.hamcrest.SpanDataMatchers.hasAttributes;
022import static org.hamcrest.Matchers.allOf;
023
024import io.opentelemetry.api.trace.Span;
025import io.opentelemetry.sdk.trace.data.SpanData;
026import org.apache.hadoop.hbase.TableName;
027import org.apache.hadoop.hbase.client.AsyncConnectionImpl;
028import org.apache.hadoop.hbase.client.ConnectionImplementation;
029import org.hamcrest.Matcher;
030
031public final class TraceTestUtil {
032
033  private TraceTestUtil() {
034  }
035
036  /**
037   * All {@link Span}s involving {@code conn} should include these attributes.
038   */
039  public static Matcher<SpanData> buildConnectionAttributesMatcher(AsyncConnectionImpl conn) {
040    return hasAttributes(
041      allOf(containsEntry("db.system", "hbase"), containsEntry("db.connection_string", "nothing"),
042        containsEntry("db.user", conn.getUser().toString())));
043  }
044
045  /**
046   * All {@link Span}s involving {@code conn} should include these attributes.
047   * @see #buildConnectionAttributesMatcher(AsyncConnectionImpl)
048   */
049  public static Matcher<SpanData> buildConnectionAttributesMatcher(ConnectionImplementation conn) {
050    return hasAttributes(
051      allOf(containsEntry("db.system", "hbase"), containsEntry("db.connection_string", "nothing"),
052        containsEntry("db.user", conn.getUser().toString())));
053  }
054
055  /**
056   * All {@link Span}s involving {@code tableName} should include these attributes.
057   */
058  public static Matcher<SpanData> buildTableAttributesMatcher(TableName tableName) {
059    return hasAttributes(allOf(containsEntry("db.name", tableName.getNamespaceAsString()),
060      containsEntry("db.hbase.table", tableName.getNameAsString())));
061  }
062}