MetricDescriptionConstants (Palladio Core)

java.lang.Object
- org.palladiosimulator.metricspec.constants.MetricDescriptionConstants

```
public final class MetricDescriptionConstants
extends Object
```
Constant metric descriptions, commonly used by ProbeFramework. TODO Let this file be generated from model. [Lehrig]

Author:

Sebastian Lehrig, Steffen Becker

Field Summary

Fields
Modifier and Type	Field and Description
`static MetricSetDescription`	`CUMULATIVE_ENERGY_CONSUMPTION_TUPLE` Specifies a `(point in time, energy consumption)` tuple, i.e., the total energy consumption until the interval ending at the specified point in time.
`static BaseMetricDescription`	`ENERGY_CONSUMPTION` Specifies the energy consumption of an entity based on its power consumption and the power consumption of potential child nodes. Thus, the power consumption value is always relative to a fixed time period.
`static BaseMetricDescription`	`EXECUTION_RESULT_METRIC` Specifies an execution results metric, e.g., to store simulated failure occurrences.
`static MetricSetDescription`	`EXECUTION_RESULT_METRIC_TUPLE` Specifies a (point in time, execution result)-tuple, i.e., time of getting the execution result plus the execution result itself.
`static BaseMetricDescription`	`HOLDING_TIME_METRIC` Specifies a holding time metric, e.g., to store the time spend in a passive resource.
`static MetricSetDescription`	`HOLDING_TIME_METRIC_TUPLE` Specifies a (point in time, holding time)-tuple, i.e., start of the holding plus the holding time.
`static BaseMetricDescription`	`INTER_ARRIVAL_TIME_CAPACITY` Maximal interarrival time for fixed resource without violating SLOs, e.g., a system scales up to 100 users per second for a fixed set of resources.
`static MetricSetDescription`	`INTER_ARRIVAL_TIME_CAPACITY_TUPLE` FIXME Artificial Metric (MetricSets are required for current UI support; generally we are just interested in a interarrival time capacity number).
`static BaseMetricDescription`	`MARGINAL_COST` Marginal cost for serving additional load, e.g., $1.00 for an additional 100 requests/hour.
`static BaseMetricDescription`	`MEAN_TIME_TO_QUALITY_REPAIR` The mean time to stop violating SLOs, e.g., 30 seconds fir an additional 10 requests/hour.
`static BaseMetricDescription`	`NUMBER_OF_RESOURCE_CONTAINERS` The number of resource containers present within a resource environment, e.g., 3 resource containers for a 3-tier resource environment.
`static MetricSetDescription`	`NUMBER_OF_RESOURCE_CONTAINERS_OVER_TIME` The number of resource containers over time, e.g., 5 resource containers after a scaling-out.
`static BaseMetricDescription`	`NUMBER_OF_SLO_VIOLATIONS` The number of SLO violations in a certain time frame, e.g., 42 SLO (response time) violations in 1 hour.
`static MetricSetDescription`	`NUMBER_OF_SLO_VIOLATIONS_OVER_TIME` The number of SLO violations counted over time, e.g., 42 SLO (response time) violations after 1 simulated hour.
`static MetricSetDescription`	`OVERALL_STATE_OF_ACTIVE_RESOURCE_METRIC` Overall state of an active resource, starting from a given point in time.
`static MetricSetDescription`	`OVERALL_STATE_OF_PASSIVE_RESOURCE_METRIC` Overall state of a passive resource, starting from a given point in time.
`static BaseMetricDescription`	`POINT_IN_TIME_METRIC` Specifies a point in time metric, e.g., to store an event time stamp.
`static BaseMetricDescription`	`POWER_CONSUMPTION` Specifies the power consumption of an entity based on its utilization and the utilization of potential child nodes. Thus, the power consumption value is always relative to a fixed time period.
`static MetricSetDescription`	`POWER_CONSUMPTION_TUPLE` Specifies a `(point in time, power consumption)` tuple, i.e., the point in time the power consumption was measured plus the consumption itself.
`static BaseMetricDescription`	`RECONFIGURATION_TIME_METRIC` Specifies a reconfiguration time metric.
`static MetricSetDescription`	`RECONFIGURATION_TIME_METRIC_TUPLE` Specifies a (point in time, reconfiguration time)-tuple, i.e., start of the reconfiguration plus the reconfiguration time.
`static BaseMetricDescription`	`RESOURCE_DEMAND_METRIC` Specifies a resource demand metric, e.g., to store CPU demand measurements.
`static MetricSetDescription`	`RESOURCE_DEMAND_METRIC_TUPLE` Specifies a (point in time, demand)-tuple, i.e., start of the demand plus the demand.
`static BaseMetricDescription`	`RESOURCE_PROVISIONING_EFFICIENCY` Efficiency of provisioning resources, e.g., 10% more resources than actual resource demand.
`static BaseMetricDescription`	`RESPONSE_TIME_METRIC` Specifies a response time metric, e.g., to store the response time of operation calls.
`static MetricSetDescription`	`RESPONSE_TIME_METRIC_TUPLE` Specifies a (point in time, response time)-tuple, i.e., start of the operation call plus the response time.
`static BaseMetricDescription`	`SCALABILITY_RANGE` Scalability range without violating SLOs, e.g., the system scales up to 1,000 users.
`static MetricSetDescription`	`SCALABILITY_SPEED` Scalability speed without violating SLOs, e.g., the system scales up to 1,000 users with increase rate 10 users/hour.
`static BaseMetricDescription`	`SLOPE` The slope for increase rates, e.g., an increase rate of 10 users/hour.
`static BaseMetricDescription`	`STATE_OF_ACTIVE_RESOURCE_METRIC` This measure represents the state of an active resource, e.g., to store CPU utilization at a certain time/state.
`static MetricSetDescription`	`STATE_OF_ACTIVE_RESOURCE_METRIC_TUPLE` Specifies a (point in time, state of active resource)-tuple, i.e., the state of an active resource plus the time when the state was taken.
`static MetricSetDescription`	`STATE_OF_ACTIVE_RESOURCE_OVER_TIME_METRIC` State of an active resource over time, e.g., to store the number of elements in the CPU queue over time.
`static BaseMetricDescription`	`STATE_OF_PASSIVE_RESOURCE_METRIC` Specifies a passive resource state metric.
`static MetricSetDescription`	`STATE_OF_PASSIVE_RESOURCE_METRIC_TUPLE` Specifies a (point in time, state of passive resource)-tuple, i.e., the state of a passive resource plus the time when the state was taken.
`static MetricSetDescription`	`STATE_OF_PASSIVE_RESOURCE_OVER_TIME_METRIC` State of a passive resource over time, e.g., to store the number of connections in a connection pool over time.
`static BaseMetricDescription`	`USER_CAPACITY` Maximal number of users for fixed resource without violating SLOs, e.g., a system scales up to 1,000 users for a fixed set of resources.
`static MetricSetDescription`	`USER_CAPACITY_TUPLE` FIXME Artificial Metric (MetricSets are required for current UI support; generally we are just interested in a user capacity number).
`static BaseMetricDescription`	`UTILIZATION_OF_ACTIVE_RESOURCE` Specifies the utilization of an active resource based on the resource's last state measurements. For example, a utilization of `50%` might indicate that the active resource was in a busy state in 5 of the last 10s, but might also indicate that the active resource was in a busy state in 7.5 of the last 15s. Thus, the utilization value is always relative to a fixed time period.
`static MetricSetDescription`	`UTILIZATION_OF_ACTIVE_RESOURCE_TUPLE` Specifies a `(point in time, utilization)` tuple, i.e., the point in time the utilization was measured plus the utilization itself.
`static BaseMetricDescription`	`WAITING_TIME_METRIC` Specifies a waiting time metric, e.g., to store the waiting time at passive resource pools.
`static MetricSetDescription`	`WAITING_TIME_METRIC_TUPLE` Specifies a (point in time, waiting time)-tuple, i.e., start of the waiting plus the waiting time.

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - POINT_IN_TIME_METRIC
```
public static final BaseMetricDescription POINT_IN_TIME_METRIC
```
    Specifies a point in time metric, e.g., to store an event time stamp.
  - RESPONSE_TIME_METRIC
```
public static final BaseMetricDescription RESPONSE_TIME_METRIC
```
    Specifies a response time metric, e.g., to store the response time of operation calls.
  - RESPONSE_TIME_METRIC_TUPLE
```
public static final MetricSetDescription RESPONSE_TIME_METRIC_TUPLE
```
    Specifies a (point in time, response time)-tuple, i.e., start of the operation call plus the response time.
  - HOLDING_TIME_METRIC
```
public static final BaseMetricDescription HOLDING_TIME_METRIC
```
    Specifies a holding time metric, e.g., to store the time spend in a passive resource.
  - HOLDING_TIME_METRIC_TUPLE
```
public static final MetricSetDescription HOLDING_TIME_METRIC_TUPLE
```
    Specifies a (point in time, holding time)-tuple, i.e., start of the holding plus the holding time.
  - WAITING_TIME_METRIC
```
public static final BaseMetricDescription WAITING_TIME_METRIC
```
    Specifies a waiting time metric, e.g., to store the waiting time at passive resource pools.
  - WAITING_TIME_METRIC_TUPLE
```
public static final MetricSetDescription WAITING_TIME_METRIC_TUPLE
```
    Specifies a (point in time, waiting time)-tuple, i.e., start of the waiting plus the waiting time.
  - RESOURCE_DEMAND_METRIC
```
public static final BaseMetricDescription RESOURCE_DEMAND_METRIC
```
    Specifies a resource demand metric, e.g., to store CPU demand measurements.
  - RESOURCE_DEMAND_METRIC_TUPLE
```
public static final MetricSetDescription RESOURCE_DEMAND_METRIC_TUPLE
```
    Specifies a (point in time, demand)-tuple, i.e., start of the demand plus the demand.
  - STATE_OF_ACTIVE_RESOURCE_METRIC
```
public static final BaseMetricDescription STATE_OF_ACTIVE_RESOURCE_METRIC
```
    This measure represents the state of an active resource, e.g., to store CPU utilization at a certain time/state.
  - STATE_OF_ACTIVE_RESOURCE_METRIC_TUPLE
```
public static final MetricSetDescription STATE_OF_ACTIVE_RESOURCE_METRIC_TUPLE
```
    Specifies a (point in time, state of active resource)-tuple, i.e., the state of an active resource plus the time when the state was taken.
  - OVERALL_STATE_OF_ACTIVE_RESOURCE_METRIC
```
public static final MetricSetDescription OVERALL_STATE_OF_ACTIVE_RESOURCE_METRIC
```
    Overall state of an active resource, starting from a given point in time. For example, this metric allows to store the utilization of a CPU over the complete simulation time.
  - STATE_OF_ACTIVE_RESOURCE_OVER_TIME_METRIC
```
public static final MetricSetDescription STATE_OF_ACTIVE_RESOURCE_OVER_TIME_METRIC
```
    State of an active resource over time, e.g., to store the number of elements in the CPU queue over time.
  - STATE_OF_PASSIVE_RESOURCE_METRIC
```
public static final BaseMetricDescription STATE_OF_PASSIVE_RESOURCE_METRIC
```
    Specifies a passive resource state metric.
  - STATE_OF_PASSIVE_RESOURCE_METRIC_TUPLE
```
public static final MetricSetDescription STATE_OF_PASSIVE_RESOURCE_METRIC_TUPLE
```
    Specifies a (point in time, state of passive resource)-tuple, i.e., the state of a passive resource plus the time when the state was taken.
  - OVERALL_STATE_OF_PASSIVE_RESOURCE_METRIC
```
public static final MetricSetDescription OVERALL_STATE_OF_PASSIVE_RESOURCE_METRIC
```
    Overall state of a passive resource, starting from a given point in time. For example, this metric allows to store the number of connections of a connection pool over the complete simulation time.
  - STATE_OF_PASSIVE_RESOURCE_OVER_TIME_METRIC
```
public static final MetricSetDescription STATE_OF_PASSIVE_RESOURCE_OVER_TIME_METRIC
```
    State of a passive resource over time, e.g., to store the number of connections in a connection pool over time.
  - EXECUTION_RESULT_METRIC
```
public static final BaseMetricDescription EXECUTION_RESULT_METRIC
```
    Specifies an execution results metric, e.g., to store simulated failure occurrences.
  - EXECUTION_RESULT_METRIC_TUPLE
```
public static final MetricSetDescription EXECUTION_RESULT_METRIC_TUPLE
```
    Specifies a (point in time, execution result)-tuple, i.e., time of getting the execution result plus the execution result itself.
  - SCALABILITY_RANGE
```
public static final BaseMetricDescription SCALABILITY_RANGE
```
    Scalability range without violating SLOs, e.g., the system scales up to 1,000 users.
  - SLOPE
```
public static final BaseMetricDescription SLOPE
```
    The slope for increase rates, e.g., an increase rate of 10 users/hour.
  - SCALABILITY_SPEED
```
public static final MetricSetDescription SCALABILITY_SPEED
```
    Scalability speed without violating SLOs, e.g., the system scales up to 1,000 users with increase rate 10 users/hour.
  - USER_CAPACITY
```
public static final BaseMetricDescription USER_CAPACITY
```
    Maximal number of users for fixed resource without violating SLOs, e.g., a system scales up to 1,000 users for a fixed set of resources.
  - USER_CAPACITY_TUPLE
```
public static final MetricSetDescription USER_CAPACITY_TUPLE
```
    FIXME Artificial Metric (MetricSets are required for current UI support; generally we are just interested in a user capacity number).
  - INTER_ARRIVAL_TIME_CAPACITY
```
public static final BaseMetricDescription INTER_ARRIVAL_TIME_CAPACITY
```
    Maximal interarrival time for fixed resource without violating SLOs, e.g., a system scales up to 100 users per second for a fixed set of resources.
  - INTER_ARRIVAL_TIME_CAPACITY_TUPLE
```
public static final MetricSetDescription INTER_ARRIVAL_TIME_CAPACITY_TUPLE
```
    FIXME Artificial Metric (MetricSets are required for current UI support; generally we are just interested in a interarrival time capacity number).
  - NUMBER_OF_SLO_VIOLATIONS
```
public static final BaseMetricDescription NUMBER_OF_SLO_VIOLATIONS
```
    The number of SLO violations in a certain time frame, e.g., 42 SLO (response time) violations in 1 hour.
  - NUMBER_OF_SLO_VIOLATIONS_OVER_TIME
```
public static final MetricSetDescription NUMBER_OF_SLO_VIOLATIONS_OVER_TIME
```
    The number of SLO violations counted over time, e.g., 42 SLO (response time) violations after 1 simulated hour.
  - MEAN_TIME_TO_QUALITY_REPAIR
```
public static final BaseMetricDescription MEAN_TIME_TO_QUALITY_REPAIR
```
    The mean time to stop violating SLOs, e.g., 30 seconds fir an additional 10 requests/hour.
  - RESOURCE_PROVISIONING_EFFICIENCY
```
public static final BaseMetricDescription RESOURCE_PROVISIONING_EFFICIENCY
```
    Efficiency of provisioning resources, e.g., 10% more resources than actual resource demand.
  - MARGINAL_COST
```
public static final BaseMetricDescription MARGINAL_COST
```
    Marginal cost for serving additional load, e.g., $1.00 for an additional 100 requests/hour.
  - UTILIZATION_OF_ACTIVE_RESOURCE
```
public static final BaseMetricDescription UTILIZATION_OF_ACTIVE_RESOURCE
```
    Specifies the utilization of an active resource based on the resource's last state measurements.
    For example, a utilization of 50% might indicate that the active resource was in a busy state in 5 of the last 10s, but might also indicate that the active resource was in a busy state in 7.5 of the last 15s.
    Thus, the utilization value is always relative to a fixed time period.
  - UTILIZATION_OF_ACTIVE_RESOURCE_TUPLE
```
public static final MetricSetDescription UTILIZATION_OF_ACTIVE_RESOURCE_TUPLE
```
    Specifies a (point in time, utilization) tuple, i.e., the point in time the utilization was measured plus the utilization itself.
    
    See Also:
    UTILIZATION_OF_ACTIVE_RESOURCE
  - POWER_CONSUMPTION
```
public static final BaseMetricDescription POWER_CONSUMPTION
```
    Specifies the power consumption of an entity based on its utilization and the utilization of potential child nodes.
    Thus, the power consumption value is always relative to a fixed time period.
  - POWER_CONSUMPTION_TUPLE
```
public static final MetricSetDescription POWER_CONSUMPTION_TUPLE
```
    Specifies a (point in time, power consumption) tuple, i.e., the point in time the power consumption was measured plus the consumption itself.
    
    See Also:
    POWER_CONSUMPTION
  - ENERGY_CONSUMPTION
```
public static final BaseMetricDescription ENERGY_CONSUMPTION
```
    Specifies the energy consumption of an entity based on its power consumption and the power consumption of potential child nodes.
    Thus, the power consumption value is always relative to a fixed time period.
    
    See Also:
    POWER_CONSUMPTION
  - CUMULATIVE_ENERGY_CONSUMPTION_TUPLE
```
public static final MetricSetDescription CUMULATIVE_ENERGY_CONSUMPTION_TUPLE
```
    Specifies a (point in time, energy consumption) tuple, i.e., the total energy consumption until the interval ending at the specified point in time.
    
    See Also:
    ENERGY_CONSUMPTION, POWER_CONSUMPTION_TUPLE
  - NUMBER_OF_RESOURCE_CONTAINERS
```
public static final BaseMetricDescription NUMBER_OF_RESOURCE_CONTAINERS
```
    The number of resource containers present within a resource environment, e.g., 3 resource containers for a 3-tier resource environment.
  - NUMBER_OF_RESOURCE_CONTAINERS_OVER_TIME
```
public static final MetricSetDescription NUMBER_OF_RESOURCE_CONTAINERS_OVER_TIME
```
    The number of resource containers over time, e.g., 5 resource containers after a scaling-out.
  - RECONFIGURATION_TIME_METRIC
```
public static final BaseMetricDescription RECONFIGURATION_TIME_METRIC
```
    Specifies a reconfiguration time metric.
  - RECONFIGURATION_TIME_METRIC_TUPLE
```
public static final MetricSetDescription RECONFIGURATION_TIME_METRIC_TUPLE
```
    Specifies a (point in time, reconfiguration time)-tuple, i.e., start of the reconfiguration plus the reconfiguration time.

Class MetricDescriptionConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POINT_IN_TIME_METRIC

RESPONSE_TIME_METRIC

RESPONSE_TIME_METRIC_TUPLE

HOLDING_TIME_METRIC

HOLDING_TIME_METRIC_TUPLE

WAITING_TIME_METRIC

WAITING_TIME_METRIC_TUPLE

RESOURCE_DEMAND_METRIC

RESOURCE_DEMAND_METRIC_TUPLE

STATE_OF_ACTIVE_RESOURCE_METRIC

STATE_OF_ACTIVE_RESOURCE_METRIC_TUPLE

OVERALL_STATE_OF_ACTIVE_RESOURCE_METRIC

STATE_OF_ACTIVE_RESOURCE_OVER_TIME_METRIC

STATE_OF_PASSIVE_RESOURCE_METRIC

STATE_OF_PASSIVE_RESOURCE_METRIC_TUPLE

OVERALL_STATE_OF_PASSIVE_RESOURCE_METRIC

STATE_OF_PASSIVE_RESOURCE_OVER_TIME_METRIC

EXECUTION_RESULT_METRIC

EXECUTION_RESULT_METRIC_TUPLE

SCALABILITY_RANGE

SLOPE

SCALABILITY_SPEED

USER_CAPACITY

USER_CAPACITY_TUPLE

INTER_ARRIVAL_TIME_CAPACITY

INTER_ARRIVAL_TIME_CAPACITY_TUPLE

NUMBER_OF_SLO_VIOLATIONS

NUMBER_OF_SLO_VIOLATIONS_OVER_TIME

MEAN_TIME_TO_QUALITY_REPAIR

RESOURCE_PROVISIONING_EFFICIENCY

MARGINAL_COST

UTILIZATION_OF_ACTIVE_RESOURCE

UTILIZATION_OF_ACTIVE_RESOURCE_TUPLE

POWER_CONSUMPTION

POWER_CONSUMPTION_TUPLE

ENERGY_CONSUMPTION

CUMULATIVE_ENERGY_CONSUMPTION_TUPLE

NUMBER_OF_RESOURCE_CONTAINERS

NUMBER_OF_RESOURCE_CONTAINERS_OVER_TIME

RECONFIGURATION_TIME_METRIC

RECONFIGURATION_TIME_METRIC_TUPLE