Article For
5.0 5.1 5.2

Time Series Settings



Time Series Settings View

"Time Series Settings View"

Time Series Settings View

  1. Time Series Settings View
    Select Settings > Time Series to open the Time Series Settings View.
  2. Enable/Disable Rollup & Retention Policies

    • Use the checkbox to select or deselect all the Rollup and Retention policies defined in your configurations.
    • Use the Set status dropdown list to enable or disable the selected policies.
      "Set Status"

      • Disabled policies will not be executed.
      • Enabled policies' execution frequency is determined -
        By the server Policy Check Frequency (see below),
        -and-
        By the Rollup Time Frame and Retention Period set by each policy.

        When a policy is executed:

        • Aggregated entries will be created according to the policy's rollup time frame.
        • Entries will be removed according to the policy's retention period.
  3. Policy Check Frequency
    Set the frequency by which the server checks and executes the Rollup and Retention policies.

    Note that any policy defined with a time frame shorter than the server's Policy Check Frequency will still be executed at the server checkup time.
    E.g., If Policy Check Frequency is set to 8 seconds, a retention policy set to 2 seconds will still be checked and executed every 8 seconds.

  4. Defined Time Series Configurations
    View and manage the time series configurations that were already defined (read more below).
  5. Add or Edit time series configurations
    • Click the Add a collection-specific configuration button to create a new configuration.
    • Click a defined configuration Edit button to edit an existing configuration.
  6. Save
    Click to save the time series configurations.

Defined Time Series Configurations

"Defined Time Series Configurations - Actions"

Defined Time Series Configurations - Actions

  1. Select Configuration
    Check to select/deselect this configuration.
    Rollup and Retention policies for selected configurations can be enabled or disabled using the time series settings view Set Status button.
  2. Enable/Disable Configuration
    Click to enable or disable Rollup and Retention policies for this configuration.
  3. Edit
    Click to edit this configuration.
  4. Remove
    Click to remove this configuration.

"Defined Time Series Configurations - Info"

Defined Time Series Configurations - Info

  1. Collection Name
    Time series configurations are defined per collection (Companies in the above image).

  2. Rollup and Retention Policies Status
    The left sidebar indicates whether Rollup and Retention policies in this configuration are enabled or disabled.

  3. Rollup and Retention Policies
    Rollup and Retention policies defined for time series in this collection (Companies).
    "Defined Configuration - Rollup and Retention"

    • (a) Raw Data
      The retention policy for the raw time series entries. In this example, entries older than 12 hours will be removed from every raw-data time series in the Companies collection.
    • (b) Rollup Policy for Raw Data
      • Rollup Policy Name
        In this example, the policy name is: ByMinute.
        Raw data of time series in the Companies collection will be aggregated into a new rollup time series named: <raw-timeseries-name>@ByMinute
      • Aggregation
        The aggregation period defined by the rollup policy.
        In this example, every 1 minute of raw data will be aggregated into a single entry of the ByMinute rollup time series.

        An entry is added to the rollup time series only when the defined aggregation time frame has ended.

      • Retention
        The retention period defined for the rollup time series entries.
        In this example, entries older than 1 hour are removed from the ByMinute rollup time series.
    • (c) Rollup Policy for Rollup Time Series
      • Rollup Policy Name
        In this example, the policy name is: 30Mins.
        Data from the rollup time series <raw-timeseries-name>@ByMinute> will be aggregated into a new rollup time series named: <raw-timeseries-name>@30Mins
      • Aggregation
        The aggregation period defined by the rollup policy.
        In this example, every 30 minutes of data from the ByMinute rollup time series will be aggregated into a single entry of the 30Mins rollup time series.

        An entry is added to the rollup time series only when the defined aggregation time frame has ended.

      • Retention
        The retention period defined for the rollup time series entries.
        In this example, entries older than 7 days are removed from the 30Mins rollup time series.
  4. Named Values
    Named values defined for time series in this collection (Companies).
    "Defined Configuration - Named Values"

    • (a) Time Series Name
      The time series for which the names are defined.
    • (b) Values and their Names
      Time series entries values, in their consecutive order within the entry (#0, #1..), with the name defined for each value.

Add or Edit Time Series Configuration

"Add or Edit Time Series Configuration"

Add or Edit Time Series Configuration

  1. Edit Configuration
    Click to edit an existing configuration.
  2. Add a Collection Specific Configuration
    Click to define a new time series configuration for one of your collections.
  3. Select Collection
    Select the collection that this time series configuration is for.
  4. Enable Retention - Raw Data
    Toggle to set a retention policy for raw time series entries.
    "Set Retention Policy"
    • (a) Enable Retention
      Enable to set a retention time period for raw data of all time series in the selected collection.
    • (b) Retention Time
      Set the retention time.
      In the example above, raw time series entries older than 1 hour will be removed.
  5. Add Rollup Policy
    Click to add a rollup policy.

    Rollup policies can be defined both for raw time series data and for rollup time series.
    Read more here.

    In the above image, the rollup policy aggregates the raw data of the selected collection's time series, into new rollup time series.
    "Set Rollup Policy"
    • (a) Policy Name
      Enter rollup policy Name
    • (b) Aggregation Time
      Set the aggregation period
      In the above example, every 10 minutes of raw time series data will be aggregated
      into a single entry of the new rollup time series.
    • (c) Enable Retention
      Enable to set a retention time period for the new rollup time series entries.

      The aggregation time cannot exceed the retention period defined for the origin time series.

  6. Add Named Values
    "Named Values"

    • (a) Time Series Name
      Enter the name of the time series whose values you want to name.
    • (b) Value Name
      Enter the name you want to give this value.
    • (c) Add Name
      Click to define an additional value name.
  7. Add
    Click OK to add this configuration to the configuration list.

    Note: Any modifications made in this view will Not be saved until you click the Save button (9).

  8. Cancel
    Click to cancel.
  9. Save
    Save all the modifications made in this view.

Rollup Policies for Rollup Time Series

  • Rollup policies can be created both for Raw time series data, and for data aggregated by other rollup time series.
  • In a time series configuration, a rollup policy's source data is determined by the policy's position.
    • The first rollup policy aggregates raw data from time series of the selected collection.
    • The second rollup policy aggregates data from the first rollup time series.
    • And so on: each additional rollup policy aggregates data from the time series that precedes it.

  • The Aggregation Time set by each policy must be greater than the aggregation time set for the previous policy.
  • The Aggregation Time cannot exceed the Retention Period defined for the previous time series.

"Rollup Policies for Rollup Time Series"

  1. Time Series Raw Data
    The raw data collected in time series of the selected collection.

  2. Rollup Time Series for Raw Data
    The ByMinute rollup policy aggregates raw data from time series in the Companies collection.
    Every minute of raw time series data, is aggregated into a single entry of the new rollup time series.

  3. Rollup Time Series for Rollup Time Series
    The 30Mins rollup policy aggregates data from the rollup time series that was created by the ByMinute policy.
    Every 30 minutes of data from the ByMinute rollup time series, are aggregated into a single entry of the new 30Mins rollup time series.