Corinneh: Published

2022-02-23T20:56:46Z

Published

New page

{{ArticlePEServiceObservability
|Monitoring====Deploy dashboard and alert dashboards===
Deploy dashboards and alert rules using these Helm charts:

*'''voice-dashboards''' – This installs the dashboards that are created to monitor various Voice Services.
*'''voice-alertrules''' – This installs the alert rules that specify what type of alarm must be triggered based on the metrics.

helm repo add helm-staging https://<jfrog artifactory/helm location> --username "$JFROG_USER" --password "$JFROG_PASSWORD"
helm repo update

helm install voice-alertrules -n voice https://<jfrog artifactory/helm location>/voice-monitoring/voice-alertrules-1.0.5.tgz --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm install voice-dashboards -n voice https://<jfrog artifactory/helm location>/voice-monitoring/voice-dashboards-1.0.8.tgz --username "$JFROG_USER" --password "$JFROG_PASSWORD"
|EnableMonitoring=You can expose metrics on a service-by-service basis. To do so, edit the '''Values.yaml''' file associated with each service, and enable metrics using either the '''Prometheus''' operator, or '''Prometheus Annotation'''.
<source lang="bash">
prometheus:
# Enable for Prometheus Annotation
metricServer:
enabled: false
path: /metrics</source>

OR

<source lang="bash">
# Enable for Prometheus operator
podMonitor:
enabled: false
path: /metrics
interval: 30s</source>
|ConfigureMetrics=The metrics that are exposed by the Voice Microservices are available by default. No further configuration is required in order to define or expose these metrics. You cannot define your own custom metrics.

The Metrics pages linked to {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Observability|anchor=MetricsLinks|display text=above}} show some of the metrics the Voice Microservices expose. You can also query Prometheus directly or via a dashboard to see all the metrics available from the Voice Microservices.
|AlertsDefined=Yes
|ExtConfigAlertsBoilerplate=Yes
|Logging=Voice Microservices can write logs generated by internal components to the following locations:

*Persistent Volume/Persistent Volume Claim with RWX storage. For more information, see {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Configure|anchor=logvolume|display text=Log volume}}, {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Deploy|anchor=DeploytheVoiceServices|display text=Deploy the Voice Services}}, and {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Deploy|anchor=OCPSIPClusterLogsPVC|display text=Persistent volumes}}.
*Ephemeral volume (emptyDir) with a Fluent Bit logging sidecar that tails log files and sends them to standard output (stdout). For more information, see {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Observability|anchor=ForwardToStdout|display text=Forwarding logs to stdout}}.

{{AnchorDiv|ForwardToStdout}}
===Forwarding logs to stdout===
You can optionally forward logs from internal components to stdout using a logging sidecar (Genesys currently supports Fluent Bit) and an ephemeral volume (emptyDir). The Fluent Bit sidecar tails the logs and sends them to stdout. For more information, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=Operations|topic=Sidecar_logging|display text=Sidecar processed logging}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=Operations|display text=Genesys Multicloud CX Private Edition Operations guide}}''.

The SIPNode logs within the SIP Cluster service can be forwarded to stdout. By default, forwarding logs to stdout is disabled. To enable the log forwarding option, set the following parameters in the voice-sip Helm Chart '''values.yaml''' file:<source lang="text">
volumes:
# Mount an Ephemeral Volume for storing the legacy SIPS logs.
sipsLog:
mountPath: "/opt/genesys/logs/sip_node/SIPS"

sipsLoggingSidecar:
enabled: true # sips-logging-sidecar container will be created
image:
registry: genesysengagedev.azurecr.io # Registry from where the images will be fetched
repository: sre/fluent-bit # repository and folder where the particular service image is located
pullPolicy: Always # Policy to pull always or only when the image is not there
tag: 1.8.x # fluent-bit version that will be used by the logging sidecar
context:
create: true #Create configmap for sips-logging-sidecar.Set to true in Values.yaml and set to false in canary_values.yaml

</source><br />
}}

VM/Current/VMPEGuide/Observability - Revision history

Corinneh: Published