Class HistorianConstants

java.lang.Object
com.inductiveautomation.historian.gateway.util.HistorianConstants

public class HistorianConstants extends Object
The HistorianConstants class defines a set of constants and utility methods used for logging, metrics, and configuration keys within the historian system.

This class provides constants for structured logging, such as logger names for various historian components (e.g., collectors, managers, providers, and storage). It also includes constants for query and storage metric keys, as well as methods for generating metric keys dynamically.

All constants and methods facilitate streamlined and consistent usage of identifiers and metrics throughout the historian system's functionality.

  • Field Details

  • Constructor Details

    • HistorianConstants

      public HistorianConstants()
  • Method Details

    • historianStatusCheckKey

      public static String historianStatusCheckKey(String historianName)
      Creates a metric key for historian status checks.
      Parameters:
      historianName - the name of the historian
      Returns:
      the formatted metric key
    • historianMetricKey

      public static String historianMetricKey(String historianName, String metric)
      Creates a metric key for specific historian metrics.
      Parameters:
      historianName - the name of the historian
      metric - the specific metric name
      Returns:
      the formatted metric key