Flags

From zzat
Jump to: navigation, search

zztat offers the following flags to customize the behavior of various framework components:

Flag Supported Objects Notes Description
DISABLE Metrics

Gauges

Reactions

Reaction Chains

This disables the entity and prevents it from running.

When set on a metric, SNAPSHOT or REPLICATE jobs will not be started.

When set on a gauge, the gauge will not be started.

When set on a reaction, the reaction will not fire. If the reaction is part of a reaction chain it will be skipped and the next reaction in the chain will fire.

Please note that when disabling a reaction that is referenced by a gauge, the gauge will fire the default reaction instead.

REPO_ONLY Gauges

Reactions

Flags the entity as repository-only. It can not run on a target database.
TARGET_ONLY Gauges

Reactions

Flags the entity as target-only. It can not run on the repository.
REPLICATE_ONLY Metrics Creates a replicate-only metric. For more details, see here.
REP_READ_ONLY Metrics Instructs the replicate process to not delete the staging table after replication.
SNAPSHOT_ONLY Metrics TBD
ON_DEMAND Metrics Creates an on-demand metric. For more details, see here.
ON_UPGRADE Metrics Used internally.

These metrics fire when any of the following conditions are detected:

- During a new zztat installation

- After zztat patch installation

- After an Oracle version change

ON_UPGRADE metrics must be ON_DEMAND metrics.

AUTOSYNC Metrics

Gauges

Creates an auto-sync metric. For mode details, see here.

When a metric is flagged as auto-sync, all of its gauges must also be flagged auto-sync.

SYNC_REACT Metrics For auto-sync metrics, waits for the reactions to complete before allowing replicate to fire. Use when reactions require access to the snapshot data.
TRUNC_ON_SNAP Metrics Instructs the SNAPSHOT process to empty the staging table prior to populating it with the metric snapshot data.
USE_QUEUE Metrics Used internally.
INTERNAL Metrics Used internally.
SNAP_TWICE Metrics Instructs the SNAPSHOT process to take two consecutive snapshots, one second apart.
LOGICAL_AND Gauges Switches the gauge column to use the logical AND operator when combining multiple columns instead of the default logical OR.
IS_DEFAULT Reactions Flags a reaction as the default reaction, which will be used when the reaction specified in the gauge fails, or is disabled.
SKIP_FAILED Reaction Chains Instructs the reaction chain to skip any reactions that failed and continue with the remaining reactions in the chain.

Settings Flags

  • You can specify flags when creating a metric, gauge or reaction, in the respective procedures in zz$manage: metric_add, gauge_add and reaction_add (and reaction_chain_add).
  • You can use the procedures metric_set_flag, metric_reset_flag to add or remove flags from a metric after it's been created.
  • You can use the procedures gauge_set_flag, gauge_reset_flag to add or remove flags from a gauge after it's been created.
  • You can use the procedures reaction_set_flag, reaction_reset_flag to add or remove flags from a reaction or reaction_chain after it's been created.

Note that zztat automatically deploys any changes to jobs that result from your flag change. It may take up to 10 seconds for the change to become effective on the repository, and up to two minutes for the change to propagate to the target databases. Alternatively, you can manually trigger a metadata refresh on the targets using the provided procedures in zz$manage.