Difference between revisions of "Template: ArticlePEServiceMetrics"

From Genesys Documentation
Jump to: navigation, search
(Porting over changes from all.docs-content (removing dupe "No alerts defined"; adding MoreMetrics info, a switch to suppress the Metrics table, and CRDs handling))
Line 7: Line 7:
 
|CRD=
 
|CRD=
 
|Annotations=
 
|Annotations=
 +
|NoCRDsOrAnnotations
 
|Port=
 
|Port=
 
|Endpoint=
 
|Endpoint=
 
|MetricsIntro=
 
|MetricsIntro=
 
|MetricsUpdateInterval=
 
|MetricsUpdateInterval=
 +
|MoreMetricsInfo=
 
}}
 
}}
 
</pre>
 
</pre>
Line 16: Line 18:
 
{{#cargo_declare:_table=ArticlePEServiceMetrics
 
{{#cargo_declare:_table=ArticlePEServiceMetrics
 
|IncludedServiceId=String
 
|IncludedServiceId=String
|CRD=String
+
|CRD=Wikitext
 
|Annotations=Wikitext
 
|Annotations=Wikitext
 +
|NoCRDsOrAnnotations=Wikitext
 
|Port=Wikitext
 
|Port=Wikitext
 
|Endpoint=Wikitext
 
|Endpoint=Wikitext
|MetricsUpdateInterval=String
+
|MetricsUpdateInterval=Wikitext
 
|MetricsIntro=Wikitext
 
|MetricsIntro=Wikitext
 
|AlertsIntro=Wikitext
 
|AlertsIntro=Wikitext
Line 34: Line 37:
 
|MetricsUpdateInterval={{{MetricsUpdateInterval|}}} }}
 
|MetricsUpdateInterval={{{MetricsUpdateInterval|}}} }}
 
{{#cargo_store:_table=ArticlePEServiceMetrics|IncludedServiceId={{{IncludedServiceId|}}}
 
{{#cargo_store:_table=ArticlePEServiceMetrics|IncludedServiceId={{{IncludedServiceId|}}}
|CRD={{{CRD|}}}
+
|CRD={{#if:{{{NoCRDsOrAnnotations|}}}|n/a|{{{CRD|}}}}}
 
|Annotations={{{Annotations|}}}
 
|Annotations={{{Annotations|}}}
|Port={{{Port|}}}
+
|NoCRDsOrAnnotations={{{NoCRDsOrAnnotations|}}}
|Endpoint={{{Endpoint|}}}
+
|Port={{#if:{{{NoCRDsOrAnnotations|}}}|n/a|{{{Port|}}}}}
 +
|Endpoint={{#if:{{{NoCRDsOrAnnotations|}}}|n/a|{{{Endpoint|}}}}}
 
|MetricsIntro={{{MetricsIntro|}}}
 
|MetricsIntro={{{MetricsIntro|}}}
 
|AlertsIntro={{{AlertsIntro|}}}
 
|AlertsIntro={{{AlertsIntro|}}}
|MetricsUpdateInterval={{{MetricsUpdateInterval|}}} }}<!-- Set MintyDocs topic, including a switch for different treatment for Manual pages -->{{#mintydocs_topic:
+
|MetricsUpdateInterval={{#if:{{{NoCRDsOrAnnotations|}}}|n/a|{{{MetricsUpdateInterval|}}}}} }}<!-- Set MintyDocs topic, including a switch for different treatment for Manual pages -->{{#mintydocs_topic:
 
|display name={{#if:{{{AltServiceDisplayName|}}}|{{{AltServiceDisplayName}}}|{{#cargo_query:tables=IncludedService,ArticlePEServiceMetrics|join on=IncludedService.Id=ArticlePEServiceMetrics.IncludedServiceId|fields=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)|no html|where=ArticlePEServiceMetrics._pageName="{{FULLPAGENAME}}"|group by=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)}}}} metrics and alerts
 
|display name={{#if:{{{AltServiceDisplayName|}}}|{{{AltServiceDisplayName}}}|{{#cargo_query:tables=IncludedService,ArticlePEServiceMetrics|join on=IncludedService.Id=ArticlePEServiceMetrics.IncludedServiceId|fields=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)|no html|where=ArticlePEServiceMetrics._pageName="{{FULLPAGENAME}}"|group by=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)}}}} metrics and alerts
 
|toc name={{#if:{{{AltServiceDisplayName|}}}|{{#cargo_query:tables=IncludedService,ArticlePEServiceMetrics|join on=IncludedService.Id=ArticlePEServiceMetrics.IncludedServiceId|fields=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)|no html|where=ArticlePEServiceMetrics._pageName="{{FULLPAGENAME}}"|group by=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)}} metrics and alerts|}}
 
|toc name={{#if:{{{AltServiceDisplayName|}}}|{{#cargo_query:tables=IncludedService,ArticlePEServiceMetrics|join on=IncludedService.Id=ArticlePEServiceMetrics.IncludedServiceId|fields=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)|no html|where=ArticlePEServiceMetrics._pageName="{{FULLPAGENAME}}"|group by=IF(IncludedService.ShortName IS NOT NULL,IncludedService.ShortName,IncludedService.Name)}} metrics and alerts|}}
Line 52: Line 56:
 
{{!}}-
 
{{!}}-
 
{{!}} {{#if:{{{NoCRDsOrAnnotations|}}}|rowspan="2"{{!}}|}}{{#if:{{{AltServiceDisplayName|}}}|{{{AltServiceDisplayName}}}|{{#cargo_query:tables=IncludedService|fields=IF(ShortName IS NOT NULL,ShortName,Name)|where=Id="{{{IncludedServiceId}}}"}}}}
 
{{!}} {{#if:{{{NoCRDsOrAnnotations|}}}|rowspan="2"{{!}}|}}{{#if:{{{AltServiceDisplayName|}}}|{{{AltServiceDisplayName}}}|{{#cargo_query:tables=IncludedService|fields=IF(ShortName IS NOT NULL,ShortName,Name)|where=Id="{{{IncludedServiceId}}}"}}}}
{{!}}{{{CRD|}}}{{{Annotations|}}}
+
{{!}} {{#if:{{{NoCRDsOrAnnotations|}}}|n/a
 +
{{!}} n/a
 +
{{!}} n/a
 +
{{!}} n/a
 +
{{!}}-
 +
{{!}} colspan="4"{{!}}{{{NoCRDsOrAnnotations}}}|{{{CRD|}}}{{{Annotations|}}}
 
{{!}}{{{Port|}}}
 
{{!}}{{{Port|}}}
 
{{!}}{{{Endpoint|}}}
 
{{!}}{{{Endpoint|}}}
{{!}}{{{MetricsUpdateInterval|}}}{{#if:{{{NoCRDsOrAnnotations|}}}|<br/>
+
{{!}}{{{MetricsUpdateInterval|}}}}}
{{!}}-
 
{{!}} colspan="4"{{!}}{{{NoCRDsOrAnnotations}}}|}}
 
 
{{!}}}
 
{{!}}}
 
{{#switch:{{{AlertsDefined}}}|No=|Yes|#default=
 
{{#switch:{{{AlertsDefined}}}|No=|Yes|#default=
Line 65: Line 72:
 
{{AnchorDiv|Metrics}}
 
{{AnchorDiv|Metrics}}
 
==Metrics==
 
==Metrics==
{{{MetricsIntro|}}}
+
{{{MetricsIntro|}}}{{#switch:{{{MetricsDefined}}}|No=|Yes|#default=
 
{{{!}} class="sortable"
 
{{{!}} class="sortable"
 
! '''Metric and description'''
 
! '''Metric and description'''
Line 73: Line 80:
 
{{{PEMetric|}}}
 
{{{PEMetric|}}}
 
{{!}}}
 
{{!}}}
 +
}}
 +
{{#if:{{{MoreMetricsInfo|}}}|{{{MoreMetricsInfo}}}|}}
  
 
{{AnchorDiv|Alerts}}
 
{{AnchorDiv|Alerts}}
 
==Alerts==
 
==Alerts==
{{#switch:{{{AlertsDefined}}}|No=No alerts are defined for {{#sub:{{MINTYDOCSMANUAL}}|0|-22}}.|Yes|#default={{#if:{{{AlertsIntro|}}}|{{{AlertsIntro}}}|}}
+
{{#switch:{{{AlertsDefined}}}|No=No alerts are defined for {{#sub:{{MINTYDOCSDISPLAYNAME}}|0|-19}}.|Yes|#default={{#if:{{{AlertsIntro|}}}|{{{AlertsIntro}}}|}}
  
 
{{#if:{{{PEAlert|}}}|The following alerts are defined for {{#sub:{{MINTYDOCSDISPLAYNAME}}|0|-19}}.
 
{{#if:{{{PEAlert|}}}|The following alerts are defined for {{#sub:{{MINTYDOCSDISPLAYNAME}}|0|-19}}.
Line 87: Line 96:
 
{{{PEAlert|}}}
 
{{{PEAlert|}}}
 
{{!}}}
 
{{!}}}
|No alerts are defined for {{#sub:{{MINTYDOCSDISPLAYNAME}}|0|-19}}.}}}}[[Category:Linkable]]</includeonly><noinclude>[[Category:PrivateEdition]]</noinclude>
+
|}}}}[[Category:Linkable]]</includeonly><noinclude>[[Category:PrivateEdition]]</noinclude>

Revision as of 14:46, November 17, 2021

This is the "ArticlePEServiceMetrics" template. It should be called in the following format:

{{ArticlePEServiceMetrics
|IncludedServiceId=
|CRD=
|Annotations=
|NoCRDsOrAnnotations
|Port=
|Endpoint=
|MetricsIntro=
|MetricsUpdateInterval=
|MoreMetricsInfo=
}}

Edit the page to see the template text. This template defines the table "ArticlePEServiceMetrics". View table. This template adds rows to the table "PEMonitoring", which is declared by the template PEMonitoring. View table.

Retrieved from "https://all.docs.genesys.com/Template:ArticlePEServiceMetrics (2024-10-06 23:53:10)"