diff --git a/frontend/src/container/OnboardingContainer/Modules/AzureMonitoring/AKS/aks-installCentralCollector.md b/frontend/src/container/OnboardingContainer/Modules/AzureMonitoring/AKS/aks-installCentralCollector.md index cb78ca5d27..b2e3a12286 100644 --- a/frontend/src/container/OnboardingContainer/Modules/AzureMonitoring/AKS/aks-installCentralCollector.md +++ b/frontend/src/container/OnboardingContainer/Modules/AzureMonitoring/AKS/aks-installCentralCollector.md @@ -4,50 +4,45 @@ Prior to installation, you must ensure your Kubernetes cluster is ready and that you have the necessary permissions to deploy applications. Follow these steps to use Helm for setting up the Collector: +  + 1. **Add the OpenTelemetry Helm repository:** ```bash helm repo add open-telemetry https://open-telemetry.github.io/opentelemetry-helm-charts ``` +  + 2. **Prepare the `otel-collector-values.yaml` Configuration** - #### Azure Event Hub Receiver Configuration - If you haven't created the logs Event Hub, you can create one by following the steps in the [Azure Event Hubs documentation](../../bootstrapping/data-ingestion). +  - and replace the placeholders `` with the primary connection string for your Event Hub, it should look something like this: +#### Azure Event Hub Receiver Configuration - ```yaml - connection: Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=superSecret1234=;EntityPath=hubName - ``` - The Event Hub docs have a step to create a SAS policy for the event hub and copy the connection string. + Replace the placeholders `` with the primary connection string for your Event Hub, it should look something like this: - #### Azure Monitor Receiver Configuration + ```yaml + connection: Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=superSecret1234=;EntityPath=hubName + ``` + The Event Hub setup have a step to create a SAS policy for the event hub and copy the connection string. - You will need to set up a [service principal](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal) with Read permissions to receive data from Azure Monitor. +  - 1. Follow the steps in the [Create a service principal Azure Doc](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-microsoft-entra-id-and-create-a-service-principal) documentation to create a service principal. - You can name it `signoz-central-collector-app` the redirect URI can be empty. - 2. To add read permissions to Azure Monitor, Follow the [Assign Role](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#assign-a-role-to-the-application) documentation. The read acess can be given to the full subscription. - 3. There are multiple ways to authenticate the service principal, we will use the client secret option, follow [Creating a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret) and don't forget to copy the client secret. The secret is used in the configuration file as `client_secret`. +#### Azure Monitor Receiver Configuration - 4. To find `client_id` and `tenant_id`, go to the [Azure Portal](https://portal.azure.com/) and search for the `Application` you created. You would see the `Application (client) ID` and `Directory (tenant) ID` in the Overview section. + You will need to set up a [service principal](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal) with Read permissions to receive data from Azure Monitor. -
- Application Overview -
- - Application Overview - -
-
+ 1. Follow the steps in the [Create a service principal Azure Doc](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#register-an-application-with-microsoft-entra-id-and-create-a-service-principal) documentation to create a service principal. + You can name it `signoz-central-collector-app` the redirect URI can be empty. + 2. To add read permissions to Azure Monitor, Follow the [Assign Role](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#assign-a-role-to-the-application) documentation. The read acess can be given to the full subscription. + 3. There are multiple ways to authenticate the service principal, we will use the client secret option, follow [Creating a client secret](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret) and don't forget to copy the client secret. The secret is used in the configuration file as `client_secret`. - 5. To find `subscription_id`, follow steps in [Find Your Subscription](https://learn.microsoft.com/en-us/azure/azure-portal/get-subscription-tenant-id#find-your-azure-subscription) and populate them in the configuration file. - - 6. Ensure you replace the placeholders `` and `` with the appropriate values for your signoz cloud instance. + 4. To find `client_id` and `tenant_id`, go to the [Azure Portal](https://portal.azure.com/) and search for the `Application` you created. You would see the `Application (client) ID` and `Directory (tenant) ID` in the Overview section. + + 5. To find `subscription_id`, follow steps in [Find Your Subscription](https://learn.microsoft.com/en-us/azure/azure-portal/get-subscription-tenant-id#find-your-azure-subscription) and populate them in the configuration file. + + 6. Ensure you replace the placeholders `` and `` with the appropriate values for your signoz cloud instance. @@ -92,13 +87,15 @@ processors: batch: {} exporters: otlp: - endpoint: "ingest..signoz.cloud:443" + endpoint: "ingest.{{REGION}}.signoz.cloud:443" tls: insecure: false headers: - "signoz-access-token": "" + "signoz-access-token": "{{SIGNOZ_INGESTION_KEY}}" ``` +  + 3. **Deploy the OpenTelemetry Collector to your Kubernetes cluster:** You'll need to prepare a custom configuration file, say `otel-collector-values.yaml`, that matches your environment's specific needs. Replace `` with the Kubernetes namespace where you wish to install the Collector.