Configuration guide

• Video tutorial
• Instructions
  • Common instructions
  • Github
  • Gitlab
  • Azure
  • Bitbucket
• Notifications
• Troubleshooting

Video tutorial

Instructions

Common instructions

All you need to configure sfdx-hardis Org Monitoring is a GitHub , Gitlab, Azure or BitBucket repository.

• Create and clone a git repository (initialize it with README)
• Open it with Visual Studio Code, then open VsCode SFDX Hardis extension menu.
  • If you need installations instructions, please visit documentation page

• Follow instructions, that can be specific according to your git provider

Tip: Schedule monitoring jobs at different hours so the notifications are more readable, for example production at 1AM and preprod at 2AM

Github

• GitHub configuration
  • Pre-requisites
  • Schedule monitoring job

Gitlab

• Gitlab configuration
  • Pre-requisites
  • Schedule monitoring job

Azure

• Azure configuration
  • Pre-requisites
  • Schedule monitoring job

Bitbucket

• Bitbucket configuration
  • Pre-requisites
  • Schedule monitoring job

Notifications

For a better user experience, it is highly recommended to configure notifications !

• Slack instructions
• Microsoft Teams instructions
• Email instructions
• API (Beta) instructions (example: for Grafana Loki integration)

You can decide to run commands but not send some notifications by defining either a notificationsDisable property in .sfdx-hardis.yml, or a comma separated list in env variable NOTIFICATIONS_DISABLE

Example in .sfdx-hardis.yml:

notificationsDisable:
  - METADATA_STATUS
  - UNUSED_METADATAS

Example in env var:

NOTIFICATIONS_DISABLE=METADATA_STATUS,UNUSED_METADATAS

Monitoring commands

You can decide to disable commands by defining either a monitoringDisable property in .sfdx-hardis.yml, or a comma separated list in env variable MONITORING_DISABLE

Example in .sfdx-hardis.yml:

monitoringDisable:
  - METADATA_STATUS
  - UNUSED_METADATAS

Example in env var:

MONITORING_DISABLE=METADATA_STATUS,UNUSED_METADATAS

Troubleshooting

You might want to customize which metadatas types are backuped, because you can't monitor more than 10000 items.

If there are more than 10000 items, your monitoring job will crash.

In that case, you can:

• Single Branch scope: Manually update file manifest/package-skip-items.xml in the branch corresponding to an org, then commit and push
• All branches scope: Define CI/CD env var MONITORING_BACKUP_SKIP_METADATA_TYPES with the list of additional metadata types you want to skip
  • example: `MONITORING_BACKUP_SKIP_METADATA_TYPES=CustomLabel,StaticResource,Translation`