alarm_analysis:meta_tags
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
alarm_analysis:meta_tags [2021/07/27 08:31] – su | alarm_analysis:meta_tags [2023/09/08 10:54] – su | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | < | + | ====== Alarm Analysis |
- | <span style=" | + | |
- | </ | + | |
- | Meta tags are used to perform various aggregations | + | The KPIs and metrics that make up the Alarm Analysis reports can be queried via //meta tags//, meaning Alarm Analysis |
- | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | + | For a full list of meta tags, refer to the [[https:// |
- | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | + | |
- | | Row 2 Col 1 | some colspan (note the double pipe) | | + | |
- | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | + | |
- | < | + | **Not all Meta Tags are Discoverable** |
- | <span style=" | + | |
- | </ | + | |
- | The following | + | While Power BI allows free text entry when configuring data queries, others apps such as Gestalt PnID and Trend restrict users to a " |
- | For example: | + | |
- | * `Oil Co/ | + | For example, |
- | * `Oil Co/ | + | |
- | * `Oil Co/ | + | |
- | < | + | Oil Co/Osprey/ALM BA report/ |
- | <span style=" | + | |
- | </html> | + | This above meta tag requests the priority of the 3rd most frequently occuring Alarm on the Oil Co Osprey asset. Clearly this is not a value you would expect to interrogate like a regular process data tag, however there may be cases where it is required. |
- | * KPI supports snapshot query (NOW value). Now value in AA defaults to **last event type message | + | If explicit tag entry is not permitted |
- | * KPI supports trend query (value over time). | + | |
- | * † Indicates that KPI supports excluding empty aggregation buckets, for example if property `// | + | |
+ | ===== How to add a "Meta Tag" to an Alarm Analysis Tag Index ===== | ||
- | ^ KPI ^ UOM ^ NOW ^ TREND ^ Functions ^ | + | If explicit tag entry is not permitted in an app, and the meta-tag is not available |
- | | **KPI Avg No Alm per 1h** † \\ *Mean average number of alarms per 1 hour buckets per selected interval | + | |
- | | **KPI Avg No Alm per 1h** † \\ *Mean average number of alarms per 1 hour buckets per selected interval in chosen period. NOTE: interval should be equal or greater than 1 hour.* | + | //Adding a meta-tag to an Alarm Analysis Tag Index will make it tag discoverable and allow other apps to query it.// |
- | | **KPI Avg No Alm per 1d** † \\ *Mean average number of alarms per 1 day buckets per selected interval in chosen period. NOTE: interval should be equal or greater than 1 day.* | count | Y | Y | | | + | |
- | | **kpi md avg no alm per 10m** † \\ *Median average number of alarms per 10 minute bucket, per interval for chosen period. NOTE: selected interval should be greater than 10 minutes.* | count | Y | Y | | | + | **Complexity Level:** Advanced |
- | | **kpi md avg no alm per 1h** † \\ *Median average number of alarms per 1 hour bucket, per interval for chosen period. NOTE: selected interval should be greater than 10 minutes.* | count | Y | Y | | | + | **Required Privileges:** App Store Connect Admiminstrator |
- | | **kpi md avg no alm per 1d** † \\ *Median average number of alarms per 1 day bucket, per interval for chosen period. NOTE: selected interval should be greater than 10 minutes.* | count | Y | Y | | | + | |
- | | **KPI avg max no alm per 10m** † \\ *Average highest alarm count in 10 minute bucket per selected interval in chosen period. NOTE: interval should be greater than 10 minutes* | + | To administer an Alarm Analysis Tag Index, you must log on the App Store Connect server hosting the Alarm Analysis data source. The instructions below are useful Powershell command. |
- | | **KPI Highest 10m** \\ *Highest alarm count in 10 minute bucket per selected interval in chosen period. NOTE: interval should be greater than 10 minutes.* | count | Y | Y | | | + | |
- | | **KPI Highest 1h** \\ *Highest alarm count in 1 hour bucket per selected interval in chosen period. Note: interval should be greater than 1 hour.* | count | Y | Y | | | + | **1. Identifiy Alarm Analysis tag indices** |
- | | **KPI No Alm** \\ *Alarm count per selected interval in chosen period.* | count | Y | Y | | | + | |
- | | **KPI No Int** \\ *Intervention count per selected interval in chosen period.* | count | Y | Y | | | + | ### Get all AA Tag Indices |
- | | **KPI No Dis** \\ *Disable count per selected interval in chosen period.* | count | Y | Y | | | + | |
- | | **KPI % 10m > 5 Alm** † \\ *Percentage of 10 minute periods containing more than 5 alarms per selected interval in chosen period. NOTE: interval should be higher than 10 minutes.* | % | Y | Y | | | + | Invoke-WebRequest -Uri http:// |
- | | **KPI % 10m > 10 Alm** † \\ *Percentage of 10 minute periods containing more than 10 alarms per selected interval in chosen period. NOTE: interval should be higher than 10 minutes.*| % | Y | Y | | | + | |
- | | **KPI % 1h > 30 Alm** † \\ *Percentage of 1 hour periods containing more than 30 alarms per selected interval in chosen period. NOTE: interval should be higher than 1 hour.* | % | Y | Y | | | + | | Select-Object -Expand Content |
- | | **KPI No 10m Accpt** † \\ *Count of number of 10 minute buckets with an acceptable number (0 or 1) of alarms per selected interval in chosen period. NOTE: interval should be higher than 10 minutes.* | count | Y | Y | | | + | |
- | | **KPI No 1h Accpt** † \\ *Count of number of 1 hour buckets with an acceptable number (<=6) of alarms per selected interval in chosen period. NOTE: interval should be higher than 1 hour.* | count | Y | Y | | | + | Tag Indices names are constructed thus: |
- | | **KPI No 1d Accpt** † \\ *Count of number of 1 day buckets with an acceptable number (<=144) of alarms per selected interval in chosen period. NOTE: interval should be higher than 1 day.* | count | Y | Y | | | + | |
- | | **KPI % Top 10 MFA** \\ *Percentage contribution of top 10 most frequent alarms | + | |
- | | **KPI % Top 10 MFI** \\ *Percentage contribution of top 10 most frequent interventions in selected period (bad actors) per selected interval in chosen period.* | % | Y | Y | | | + | e.g. " |
- | | **KPI Longest Flood** \\ *Longest flood time span per selected interval | + | |
- | | **KPI % time in flood** \\ *Percentage time spent in flood per selected interval in the chosen period.* | % | Y | Y | | | + | **2. Find a meta-tag in the tag index** |
- | | **KPI Flood Count** \\ *Flood count per selected interval for chosen period. NOTE: interval should be greater than 0 minutes.* | count | Y | Y | | | + | |
- | | **KPI avg % time > steady target (>1)** \\ *n/a* | % | Y | Y | | | + | ### Find tag |
- | | **KPI avg % time > upset target (>10)** \\ *n/a* | % | Y | Y | | | + | |
+ | $body=' | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | }' | ||
+ | |||
+ | Invoke-RestMethod -Uri http:// | ||
+ | | ||
+ | -Method Post ` | ||
+ | -Body $body ` | ||
+ | | ||
+ | |||
+ | The above query is checking the " | ||
+ | |||
+ | **3. Add an meta-tag to a tag index** | ||
+ | |||
+ | Only add a meta-tag to the tag-index, if... | ||
+ | |||
+ | | ||
+ | * You have a valid meta-tag name - //check against the meta-tag list.// | ||
+ | |||
+ | |||
+ | ### Create tag | ||
+ | |||
+ | $body=' | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }' | ||
+ | |||
+ | Invoke-RestMethod -Uri http:// | ||
+ | -ContentType ' | ||
+ | -Method Post ` | ||
+ | -Body $body ` | ||
+ | | ||
+ | | ||
+ | **4. Delete a meta-tag from the tag index** | ||
+ | |||
+ | Every tag in the tag index has a unique " | ||
+ | |||
+ | Use the search query above to obtain | ||
+ | |||
+ | ### Delete tag | ||
+ | |||
+ | Invoke-RestMethod -Uri http:// | ||
+ | | ||
+ | -Method Delete ` | ||
+ | | ||
+ | |||
+ | |||
+ |
alarm_analysis/meta_tags.txt · Last modified: 2024/01/31 14:23 by su