Form:ArticlePEServiceMetrics - Revision history

WikiSysop at 15:16, September 9, 2022

2022-09-09T15:16:00Z

Barry.grenon@genesys.com at 15:28, November 24, 2021

2021-11-24T15:28:34Z

Jose.druker@genesys.com: Porting over changes from all.docs-content (making the Label field a text box; adding MetricsDefined and MoreMetricsInfo fields)

2021-11-17T14:51:11Z

Porting over changes from all.docs-content (making the Label field a text box; adding MetricsDefined and MoreMetricsInfo fields)

Jose.druker@genesys.com: Adding a new field for NoCRDsOrAnnotations

2021-10-21T20:58:08Z

Adding a new field for NoCRDsOrAnnotations

Barry.grenon@genesys.com: Reverted edits by Barry.grenon@genesys.com (talk) to last revision by Jose.druker@genesys.com

2021-10-21T15:53:51Z

Reverted edits by Barry.grenon@genesys.com (talk) to last revision by Jose.druker@genesys.com

Barry.grenon@genesys.com at 15:49, October 21, 2021

2021-10-21T15:49:04Z

Jose.druker@genesys.com at 19:08, October 15, 2021

2021-10-15T19:08:46Z

Jose.druker@genesys.com: Adding a new field for AltServiceDisplayName

2021-10-14T17:57:20Z

Adding a new field for AltServiceDisplayName

Ed.jamer@genesys.com: Update package: PrivateEdition

2021-10-04T19:51:06Z

Update package: PrivateEdition

New page

<noinclude>
This is the "ArticlePEServiceMetrics" form.
To create a page with this form, enter the page name below;
if a page with that name already exists, you will be sent to a form to edit that page.

{{#forminput:form=ArticlePEServiceMetrics}}

</noinclude><includeonly>
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"> </div>
{{{for template|ArticlePEServiceMetrics}}}

<div class="col-md-2 form-label">Included Service {{FormTip|Choose the service that contains the applicable Helm chart.}}</div>
<div class="col-md-10 ve-height">{{{field|IncludedServiceId|input type=dropdown|cargo table=IncludedService|cargo field=Id|mapping template=IncludedServiceMap}}} </div>

<div class="col-md-2 form-label">CRD {{FormTip|Specify the CRD if the service uses one —e.g., PodMonitor or ServiceMonitor. Populate either this CRDs field or the "Annotations" one.}}</div>
<div class="col-md-10 ve-height">{{{field|CRD}}} </div>

<div class="col-md-2 form-label">Annotations {{FormTip|If the service uses annotations instead of CRD(s), specify the annotations. You can use wiki markup in this field. Populate either this Annotations field or the "CRD" one.}}</div>
<div class="col-md-10 ve-height">{{{field|Annotations}}} </div>

<div class="col-md-2 form-label">Port </div>
<div class="col-md-10 ve-height">{{{field|Port}}} </div>

<div class="col-md-2 form-label">Endpoint/Selector {{FormTip|Specify the monitoring endpoint/URI Prometheus will scrape. If it's not possible to specify this straightforwardly (for example, if a service with no sticky network identity uses a PodMonitor), show the selector details. You can use wiki markup in this field.}}</div>
<div class="col-md-10 ve-height">{{{field|Endpoint|input type=textarea|editor=visualeditor|max height=200}}} </div>

<div class="col-md-2 form-label">Metrics update interval </div>
<div class="col-md-10 ve-height">{{{field|MetricsUpdateInterval}}} </div>

<div style="clear:both"></div>

==Metrics==
Add any service-specific information about the metrics. There is no boilerplate introductory material.
<div class="col-md-12 ve-height">{{{field|MetricsIntro|input type=textarea|editor=visualeditor}}}</div>

<div class="col-md-12 ve-height">{{{field|PEMetric|holds template}}}</div>

==Alerts==
Add any service-specific information about the alerts. Following whatever you specify here, the template adds a boilerplate introductory paragraph, which is reproduced in the tooltip for convenience. {{FormTip|''The following introductory sentence displays by default:''

The following alerts are defined for {{#sub:{{MINTYDOCSDISPLAYNAME}}|0|-19}}.}}

<div class="col-md-12 ve-height">{{{field|AlertsIntro|input type=textarea|editor=visualeditor}}}</div>

<div class="col-md-12 ve-height">{{{field|PEAlert|holds template}}}</div>

{{{end template}}}

{{{for template|PEMetric|multiple|add button text=Add metric|embed in field=ArticlePEServiceMetrics[PEMetric]}}}
{{Field|Metric|{{{field|Metric}}} }}
{{Field|Type|{{{field|Type}}} }}
{{Field|Unit|{{{field|Unit}}} }}
{{Field|Label|{{{field|Label}}} }}
<div class="col-md-12 ve-height">{{Field|Description|{{{field|MetricDescription|input type=textarea|editor=visualeditor}}} }}</div>
{{Field|SampleValue|{{{field|SampleValue}}} }}
{{Field|UsedFor|{{{field|UsedFor}}} }}
{{{end template}}}

{{{for template|PEAlert|multiple|add button text=Add alert|embed in field=ArticlePEServiceMetrics[PEAlert]}}}
{{Field|Alert|{{{field|Alert}}} }}
{{Field|Severity|{{{field|Severity}}} }}
<div class="col-md-12 ve-height">{{Field|Description|{{{field|AlertDescription|input type=textarea|editor=visualeditor}}} }}</div>
{{Field|Based on:|{{{field|BasedOn}}} }}
{{Field|Threshold|{{{field|Threshold}}} }}
{{{end template}}}

{{{standard input|summary}}}

{{{standard input|minor edit}}} {{{standard input|watch}}}

{{{standard input|save}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}
</includeonly>
{{FormCSS}}

<noinclude>[[Category:PrivateEdition]] [[Category:ActiveForms]]</noinclude>

@@ Line 16: / Line 16: @@
 <div class="col-md-2 form-label">(Optional) Service name for the H1 {{FormTip|By default, the service's shortname will be used in the H1 ("<Service shortname> metrics and alerts"), the "Service" column in the Monitoring summary, and link display text. If you want to use a different service name, specify it here. Note that the shortname will still be used in the TOC entry.}}</div>
 <div class="col-md-10 ve-height">{{{field|AltServiceDisplayName}}} </div>
 <div class="col-md-2 form-label">CRD {{FormTip|Specify the CRD if the service uses one &mdash;e.g., PodMonitor or ServiceMonitor. Populate either this CRDs field or the "Annotations" one.}}</div>
@@ Line 55: / Line 59: @@
 {{{end template}}}
-{{{for template|PEMetric|multiple|add button text=Add metric|embed in field=ArticlePEServiceMetrics[PEMetric]}}}
+{{{for template|PEMetric|multiple|add button text=Add metric|displayed fields when minimized=Metric|embed in field=ArticlePEServiceMetrics[PEMetric]}}}
 {{Field|Metric|{{{field|Metric}}} }}
 {{Field|Type|{{{field|Type}}} }}
@@ Line 66: / Line 70: @@
-{{{for template|PEAlert|multiple|add button text=Add alert|embed in field=ArticlePEServiceMetrics[PEAlert]}}}
+{{{for template|PEAlert|multiple|add button text=Add alert|displayed fields when minimized=Alert|embed in field=ArticlePEServiceMetrics[PEAlert]}}}
 {{Field|Alert|{{{field|Alert}}} }}
 {{Field|Severity|{{{field|Severity}}} }}

@@ Line 12: / Line 12: @@
 <div class="col-md-2 form-label">Included Service {{FormTip|Choose the service that contains the applicable Helm chart.}}</div>
-<div class="col-md-10 ve-height">{{{field|IncludedServiceId|input type=combobox|cargo table=IncludedService|cargo field=Id|mapping template=IncludedServiceMap}}} </div>
+<div class="col-md-10 ve-height">{{{field|IncludedServiceId|input type=dropdown|cargo table=IncludedService|cargo field=Id|mapping template=IncludedServiceMap}}} </div>
 <div class="col-md-2 form-label">(Optional) Service name for the H1 {{FormTip|By default, the service's shortname will be used in the H1 ("<Service shortname> metrics and alerts"), the "Service" column in the Monitoring summary, and link display text. If you want to use a different service name, specify it here. Note that the shortname will still be used in the TOC entry.}}</div>

@@ Line 12: / Line 12: @@
 <div class="col-md-2 form-label">Included Service {{FormTip|Choose the service that contains the applicable Helm chart.}}</div>
-<div class="col-md-10 ve-height">{{{field|IncludedServiceId|input type=dropdown|cargo table=IncludedService|cargo field=Id|mapping template=IncludedServiceMap}}} </div>
+<div class="col-md-10 ve-height">{{{field|IncludedServiceId|input type=combobox|cargo table=IncludedService|cargo field=Id|mapping template=IncludedServiceMap}}} </div>
 <div class="col-md-2 form-label">(Optional) Service name for the H1 {{FormTip|By default, the service's shortname will be used in the H1 ("<Service shortname> metrics and alerts"), the "Service" column in the Monitoring summary, and link display text. If you want to use a different service name, specify it here. Note that the shortname will still be used in the TOC entry.}}</div>

@@ Line 11: / Line 11: @@
 {{{for template|ArticlePEServiceMetrics}}}
-<div class="col-md-2 form-label">Included Service {{FormTip|Choose the service that contains the applicable Helm chart.}}</div>
+<div class="col-md-2 form-label">Included Service {{FormTip|If this topic is for an included service, select the required service. If this topic is NOT for an included service, this field will inherit from the Service setting applied to the manual as a whole: no writer action required.}}</div>
 <div class="col-md-10 ve-height">{{{field|IncludedServiceId|input type=dropdown|cargo table=IncludedService|cargo field=Id|mapping template=IncludedServiceMap}}} </div>

@@ Line 87: / Line 87: @@
 {{{standard input|minor edit}}} {{{standard input|watch}}}
-{{{standard input|save}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}
+{{{standard input|save}}} {{{standard input|save and continue}}} {{{standard input|preview}}} {{{standard input|changes}}} {{{standard input|cancel}}}
 </includeonly>
 {{FormCSS}}
 <noinclude>[[Category:PrivateEdition]] [[Category:ActiveForms]]</noinclude>

@@ Line 21: / Line 21: @@
 <div class="col-md-12 ve-height">{{{field|NoCRDsOrAnnotations|input type=textarea|editor=visualeditor}}}</div>
-<div class="col-md-2 form-label">CRD {{FormTip|Specify the CRD if the service uses one &mdash;e.g., PodMonitor or ServiceMonitor. Populate either this CRDs field or the "Annotations" one.}}</div>
+<div class="col-md-2 form-label">CRD {{FormTip|Specify the CRD if the service uses one &mdash;e.g., PodMonitor or ServiceMonitor. Populate either this CRDs field or the "Annotations" one. If your service uses both, enter a statement to this effect in the CRDs field.}}</div>
 <div class="col-md-10 ve-height">{{{field|CRD}}} </div>
@@ Line 39: / Line 39: @@
 ==Metrics==
-Add any service-specific information about the metrics. There is no boilerplate introductory material.
+Are metrics defined for this service? {{FormTip|''If you select "No" the Metrics table will not display.}}{{{field|MetricsDefined|input type=radiobutton|values=Yes,No|default=Yes|mandatory}}}
 <div class="col-md-12 ve-height">{{{field|MetricsIntro|input type=textarea|editor=visualeditor}}}</div>
 <div class="col-md-12 ve-height">{{{field|PEMetric|holds template}}}</div>
 ==Alerts==
@@ Line 63: / Line 68: @@
 {{Field|Type|{{{field|Type}}} }}
 {{Field|Unit|{{{field|Unit}}} }}
-{{Field|Label|{{{field|Label}}} }}
+<div class="col-md-12 ve-height">{{Field|Label|{{{field|Label|input type=textarea|editor=visualeditor}}} }}</div>
 <div class="col-md-12 ve-height">{{Field|Description|{{{field|MetricDescription|input type=textarea|editor=visualeditor}}} }}</div>
 {{Field|SampleValue|{{{field|SampleValue}}} }}

@@ Line 24: / Line 24: @@
 <div class="col-md-2 form-label">Port </div>
-<div class="col-md-10 ve-height">{{{field|Port}}} </div>
+<div class="col-md-10 ve-height">{{{field|Port|input type=textarea|editor=visualeditor|max height=50}}} </div>
 <div class="col-md-2 form-label">Endpoint/Selector {{FormTip|Specify the monitoring endpoint/URI Prometheus will scrape. If it's not possible to specify this straightforwardly (for example, if a service with no sticky network identity uses a PodMonitor), show the selector details. You can use wiki markup in this field.}}</div>
@@ Line 41: / Line 41: @@
 ==Alerts==
 Add any service-specific information about the alerts. Following whatever you specify here, the template adds a boilerplate introductory paragraph, which is reproduced in the tooltip for convenience. {{FormTip|''The following introductory sentence displays by default:''