Configure by Helm command
You need to specify the parameters of the Azure Synapse workspace to be monitored in the helm command as below.
helm install spo synapse-charts/synapse-prometheus-operator --create-namespace --namespace spo \
--set synapse.workspaces[0].workspace_name="<workspace_name>" \
--set synapse.workspaces[0].tenant_id="<tenant_id>" \
--set synapse.workspaces[0].service_principal_name="<service_principal_app_id>" \
--set synapse.workspaces[0].service_principal_password="<service_principal_password>" \
--set synapse.workspaces[0].subscription_id="<subscription_id>" \
--set synapse.workspaces[0].resource_group="<workspace_resource_group_name>"
This helm command will generate the config.yaml for the Azure Synapse Prometheus connector. Here is an example.
Configuration Items
Config Item |
Required |
Default |
Description |
workspace_name |
True |
- |
The Azure Synapse workspace name. |
tenant_id |
True |
- |
The Azure subscription tenant id. |
service_principal_name |
True |
- |
Azure service principal app id. |
service_principal_password |
True |
- |
Azure service principal password. |
synapse_host_suffix |
False |
dev.azuresynapse.net |
Azure Synapse workspace endpoint suffix. |
synapse_api_version |
False |
2019-11-01-preview |
Valid api-version for the request. Currently, it is "2019-11-01-preview". |
resource_uri |
False |
https://dev.azuresynapse.net |
Azure synapse resource uri for authorization. |
token_refresh_interval_sec |
False |
1800 |
AAD Token refresh interval in seconds. |
spark_application_discovery_interval_sec |
False |
10 |
Spark application list refresh interval in seconds. |
enable_spark_pools_metadata_metrics |
False |
true |
Expose spark pools metadata as Prometheus metrics. |
azure_management_resource_uri |
False |
https://management.azure.com |
Spark application list refresh interval in seconds. |
subscription_id |
False |
- |
Azure Synapse workspace subscription id. Required if enable_spark_pools_metadata_metrics is true. |
resource_group |
False |
- |
Azure Synapse workspace resource group name. Required if enable_spark_pools_metadata_metrics is true. |