io.temporal.opentracing.provider.DataDogOpenTracingSpanBuilderProvider Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of temporal-opentracing Show documentation

Temporal Java SDK OpenTracing Support Module

There is a newer version: 1.25.1

/*
 * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved.
 *
 * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Modifications copyright (C) 2017 Uber Technologies, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this material 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 io.temporal.opentracing.provider;

import io.temporal.opentracing.SpanBuilderProvider;
import io.temporal.opentracing.SpanCreationContext;
import io.temporal.opentracing.SpanOperationType;
import io.temporal.opentracing.internal.ActionTypeAndNameSpanBuilderProvider;
import java.util.HashMap;
import java.util.Map;

/**
 * This implementation of {@link SpanBuilderProvider} names and tags the OpenTracing spans in a way
 * that is compatible with DataDog's APM tooling.
 *
 * Spans are named with the operation type default prefixes from {@link
 * SpanOperationType#getDefaultPrefix()} (e.g. "StartActivity") and set a tag with key
 * "resource.name" and the value is the name of the activity or workflow or child workflow. See here
 * for the datadog standard tag names.
 */
public class DataDogOpenTracingSpanBuilderProvider extends ActionTypeAndNameSpanBuilderProvider {
  public static final DataDogOpenTracingSpanBuilderProvider INSTANCE =
      new DataDogOpenTracingSpanBuilderProvider();

  private static final String DD_RESOURCE_NAME_TAG = "resource.name";

  /** Uses just the operation type as the name, e.g. "StartActivity" */
  @Override
  protected String getSpanName(SpanCreationContext context) {
    return context.getSpanOperationType().getDefaultPrefix();
  }

  /**
   * Includes the default tags but also uses {@link SpanCreationContext#getActionName()} as a tag
   * with the key "resource.name"
   */
  @Override
  protected Map getSpanTags(SpanCreationContext context) {
    Map tags = new HashMap<>();
    tags.putAll(super.getSpanTags(context));
    tags.put(DD_RESOURCE_NAME_TAG, context.getActionName());
    return tags;
  }
}