AppIncubatingAttributes.java

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.semconv.incubating;

import static io.opentelemetry.api.common.AttributeKey.doubleKey;
import static io.opentelemetry.api.common.AttributeKey.longKey;
import static io.opentelemetry.api.common.AttributeKey.stringKey;

import io.opentelemetry.api.common.AttributeKey;

// DO NOT EDIT, this is an Auto-generated file from
// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2
@SuppressWarnings("unused")
public final class AppIncubatingAttributes {
  /** Unique identifier for a particular build or compilation of the application. */
  public static final AttributeKey<String> APP_BUILD_ID = stringKey("app.build_id");

  /**
   * A unique identifier representing an instance of an end-user facing app crash.
   *
   * <p>Notes:
   *
   * <p>Its value MAY be meaningful and be used as a reference for telemetry and metadata recorded
   * by the same instrumentation (e.g. it is an ID generated by an external source that captured the
   * crash). It MAY come from a source external to the instrumentation such that it can be used to
   * look up additional data from other sources as well as facilitate deduplication.
   */
  public static final AttributeKey<String> APP_CRASH_ID = stringKey("app.crash.id");

  /**
   * A unique identifier representing the installation of an application on a specific device
   *
   * <p>Notes:
   *
   * <p>Its value SHOULD persist across launches of the same application installation, including
   * through application upgrades. It SHOULD change if the application is uninstalled or if all
   * applications of the vendor are uninstalled. Additionally, users might be able to reset this
   * value (e.g. by clearing application data). If an app is installed multiple times on the same
   * device (e.g. in different accounts on Android), each {@code app.installation.id} SHOULD have a
   * different value. If multiple OpenTelemetry SDKs are used within the same application, they
   * SHOULD use the same value for {@code app.installation.id}. Hardware IDs (e.g. serial number,
   * IMEI, MAC address) MUST NOT be used as the {@code app.installation.id}.
   *
   * <p>For iOS, this value SHOULD be equal to the <a
   * href="https://developer.apple.com/documentation/uikit/uidevice/identifierforvendor">vendor
   * identifier</a>.
   *
   * <p>For Android, examples of {@code app.installation.id} implementations include:
   *
   * <ul>
   *   <li><a href="https://firebase.google.com/docs/projects/manage-installations">Firebase
   *       Installation ID</a>.
   *   <li>A globally unique UUID which is persisted across sessions in your application.
   *   <li><a href="https://developer.android.com/identity/app-set-id">App set ID</a>.
   *   <li><a
   *       href="https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID">{@code
   *       Settings.getString(Settings.Secure.ANDROID_ID)}</a>.
   * </ul>
   *
   * <p>More information about Android identifier best practices can be found in the <a
   * href="https://developer.android.com/training/articles/user-data-ids">Android user data IDs
   * guide</a>.
   */
  public static final AttributeKey<String> APP_INSTALLATION_ID = stringKey("app.installation.id");

  /**
   * A number of frame renders that experienced jank.
   *
   * <p>Notes:
   *
   * <p>Depending on platform limitations, the value provided MAY be approximation.
   */
  public static final AttributeKey<Long> APP_JANK_FRAME_COUNT = longKey("app.jank.frame_count");

  /** The time period, in seconds, for which this jank is being reported. */
  public static final AttributeKey<Double> APP_JANK_PERIOD = doubleKey("app.jank.period");

  /** The minimum rendering threshold for this jank, in seconds. */
  public static final AttributeKey<Double> APP_JANK_THRESHOLD = doubleKey("app.jank.threshold");

  /** The x (horizontal) coordinate of a screen coordinate, in screen pixels. */
  public static final AttributeKey<Long> APP_SCREEN_COORDINATE_X =
      longKey("app.screen.coordinate.x");

  /** The y (vertical) component of a screen coordinate, in screen pixels. */
  public static final AttributeKey<Long> APP_SCREEN_COORDINATE_Y =
      longKey("app.screen.coordinate.y");

  /**
   * An identifier that uniquely differentiates this screen from other screens in the same
   * application.
   *
   * <p>Notes:
   *
   * <p>A screen represents only the part of the device display drawn by the app. It typically
   * contains multiple widgets or UI components and is larger in scope than individual widgets.
   * Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
   */
  public static final AttributeKey<String> APP_SCREEN_ID = stringKey("app.screen.id");

  /**
   * The name of an application screen.
   *
   * <p>Notes:
   *
   * <p>A screen represents only the part of the device display drawn by the app. It typically
   * contains multiple widgets or UI components and is larger in scope than individual widgets.
   * Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
   */
  public static final AttributeKey<String> APP_SCREEN_NAME = stringKey("app.screen.name");

  /**
   * An identifier that uniquely differentiates this widget from other widgets in the same
   * application.
   *
   * <p>Notes:
   *
   * <p>A widget is an application component, typically an on-screen visual GUI element.
   */
  public static final AttributeKey<String> APP_WIDGET_ID = stringKey("app.widget.id");

  /**
   * The name of an application widget.
   *
   * <p>Notes:
   *
   * <p>A widget is an application component, typically an on-screen visual GUI element.
   */
  public static final AttributeKey<String> APP_WIDGET_NAME = stringKey("app.widget.name");

  // Enum definitions

  private AppIncubatingAttributes() {}
}