diff --git a/docs/user-guide/telemetry-collector/azure-native-integration.md b/docs/user-guide/telemetry-collector/azure-native-integration.md index 76e77620..ee61ee72 100644 --- a/docs/user-guide/telemetry-collector/azure-native-integration.md +++ b/docs/user-guide/telemetry-collector/azure-native-integration.md @@ -1,6 +1,9 @@ --- sidebar_position: 6 title: Configure Azure Native Integration +image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg +description: Step by step guide to configuring Azure native integration +keywords: [Azure, Azure native integration, ship Azure data, Azure logs, Azure metrics, Azure tracing, Azure Logz.io] --- @@ -10,9 +13,6 @@ Azure Native Integration offers a fast and efficient way to sync your Azure data Azure may **charge additional fees** for using this integration. [Read more about Azure API costs](https://azure.microsoft.com/en-us/pricing/details/api-management/). ::: -* [Set up Azure Native Integration](/user-guide/cloud-fetcher.html#set-up-azure-cloud-fetcher) -* [Set up Logz.io's Azure Native Integration](/user-guide/cloud-fetcher.html#set-up-logzios-azure-cloud-fetcher) - ## Set up Azure Native Integration @@ -60,6 +60,26 @@ Ensure that the **User, group, or service principal** option is checked in the M Search for the name of the app you created and select it. Click **Review + assign** to confirm. Click on **Review + assign** again to apply the role. +### _(Optional)_ - Collect logs with Azure Native Integration + +Azure Native Integration collects metrics data by default. If you wish to collect and monitor your logs, you'll need to: + +1. [Create a workspace in Azure](https://learn.microsoft.com/en-us/azure/machine-learning/quickstart-create-resources?view=azureml-api-2) +2. Ship logs to your log analytics workspace via Diagnostic Settings / Data Collection Rules / Application Insights + +You must configure your logs through the relevant settings according to your Azure account. Once configured, Logz.io can collect and monitor the desired logs. + +For example, if you have a **Kubernetes service**, you can configure your logs via Diagnostic Settings. + +Navigate to **Kubernetes service** > **Diagnostic settings**, choose the storage account you want to enable diagnostics for and click **Add diagnostic settings**. + +Next, choose which log categories to monitor and set up the Destination details to Send to the Log Analytics workspace. + +Once you connect your Azure Native Integration with Logz.io, it'll have access to all logs inside the workspace, which will be monitored on your Logz.io dashboard. + +![configure logs in Azure](https://dytvr9ot2sszz.cloudfront.net/logz-docs/fetcher/diagnostic-settings.png) + + ### Send your details to Logz.io To connect your Azure Native Integration with Logz.io you'll need to send the following information: diff --git a/docs/user-guide/telemetry-collector/telemetry-collector-aws.md b/docs/user-guide/telemetry-collector/telemetry-collector-aws.md index 02027d41..7c91285f 100644 --- a/docs/user-guide/telemetry-collector/telemetry-collector-aws.md +++ b/docs/user-guide/telemetry-collector/telemetry-collector-aws.md @@ -1,6 +1,9 @@ --- sidebar_position: 2 title: Send AWS data with Telemetry Collector +image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg +description: Send your AWS data with Logz.io's Telemetry Collector +keywords: [AWS, Amazon Web Service, ship AWS data, AWS logs, AWS metrics, AWS tracing] --- :::note @@ -9,6 +12,7 @@ Telemetry Collector is currently **available in all regions** except for Japan a To start sending your AWS data through the Telemetry Collector, Log into your **main** Logz.io account, navigate to [Send your data](https://app.logz.io/#/dashboard/send-your-data), and click on **Start collecting**. + :::caution Important To configure the Telemetry Collector, you must be logged into your **main** Logz.io account. ::: @@ -17,53 +21,59 @@ To configure the Telemetry Collector, you must be logged into your **main** Logz This integration is only compatible with Amazon Linux version 2 on EC2. The use of version 1 is deprecated. ::: -![Start collecting button](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-start-here.png) +![Start collecting button](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/start-collecting-sep.png) ## Prerequisite The IAM role assigned to the EC2 instance must include the `ec2:DescribeTags` permission in its policy. +## Configure Collector -## Start sending AWS data - -### 1. Select platform +### Select your environment Select the AWS platform and the relevant sub-type through which you want to send your data. -![Select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/aws-agent.png) +![Select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/collector-main-aws-sep.png) -### 2. Select data sources +### Select data sources -Enter the full path location of your log files from your machine. You can add multiple files by clicking on the **Add a file** option. +Each AWS environment requires different elements to collect your data. -Logz.io uses OpenTelemetry to monitor your EC2. +* **AWS Logs** - Select your region, AWS services, and Custom Log Groups. +* **AWS Metrics** - Select your region and AWS namespace. +* **EC2 Monitoring** - Auto collects the data. Logz.io uses OpenTelemetry to monitor your EC2. -![Select data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-aws-data-source.png) +![Select data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/configure-aws-sep.png) -### 3. Define your collector +### Define your collector -Choose a name and write a description to help identify the collector. +You can edit your collector’s name and description and choose which Logs, Metrics, and Tracing accounts to use. If you don’t have active accounts, you’ll be able to review the newly generated account names before continuing. -Under **Accounts**, you can review the Logs and Metrics accounts to which the Telemetry Collector will send the data. If you don't have an existing account, one will be generated for you, and you’ll be able to review its name before continuing. +Click **Generate collector** to continue. -Click **Generate snippet** to continue. +![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/define-aws-sep.png) -![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-aws-define.png) -### 4. Install the Telemetry Collector +### _Optional_ - Define your EC2 collector -Copy the code snippet and **run it in your EC2** to install the AWS Telemetry Collector. +You can configure the data sources the Telemetry Collector will collect. To do so, after choosing the EC2 Monitoring option, click on **Advance settings** at the top of the page. Next, you can edit and change the location of your logs, and whether you want to monitor both logs and metrics. -:::note -Some platforms might require additional details, such as admin privileges or passwords, to complete the installation. These details are not sent to or stored by Logz.io. -::: -![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/collector-localhost-finish.png) +![configure ec2 data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/configure-ec2-sep.png) + + +### Install the Telemetry Collector + + +Login to your AWS account, launch the AWS stack to run stack configuration and click the **Run AWS stack** button to activate your collector. + +Some platforms might require additional details, such as admin privileges or passwords, to complete the installation. These details are not sent to or stored by Logz.io. +{:.info-box.note} -### 5. Collect data +![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/activate-aws-sep.png) -That’s it! It might take a while for the Telemetry Collector to get up and running, after which you’ll be able to view your logs, metrics, or traces and get full observability into your system. +It might take a while for the Telemetry Collector to get up and running, after which you’ll be able to view your logs, metrics, or traces and get full observability into your system. ## Manage your Telemetry Collector: @@ -84,6 +94,6 @@ To manage an AWS Telemetry Collector on your **Linux** machine, you can use the If you have additional questions about managing your Telemetry Collector, [contact Logz.io's Support team](mailto:help@logz.io). -###### Additional resources +## Additional resources * [View Telemetry Collector on GitHub](https://github.com/logzio/logzio-agent-manifest) \ No newline at end of file diff --git a/docs/user-guide/telemetry-collector/telemetry-collector-k8s.md b/docs/user-guide/telemetry-collector/telemetry-collector-k8s.md index bb6add92..97229d34 100644 --- a/docs/user-guide/telemetry-collector/telemetry-collector-k8s.md +++ b/docs/user-guide/telemetry-collector/telemetry-collector-k8s.md @@ -1,6 +1,9 @@ --- sidebar_position: 3 title: Send Kubernetes Data with Telemetry Collector +image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg +description: Send your Kubernetes data with Logz.io's Telemetry Collector +keywords: [Kubernetes, ship kubernetes data, kubernetes logs, kubernetes metrics, kubernetes tracing] --- :::note @@ -15,69 +18,71 @@ To start sending your Kubernetes data through the Telemetry Collector, you'll ne _If you're unsure whether traffic is allowed to these ports, continue the process, and Logz.io will notify you if access is restricted._ -Navigate to [Send your data](https://app.logz.io/#/dashboard/send-your-data), and click on **Start collecting**. +Navigate to [Send your data](https://app.logz.io/#/dashboard/send-your-data), and click on **Go to the Telemetry Collector**. :::caution Important To configure the Telemetry Collector, you must be logged into your **main** Logz.io account. ::: -![Start collecting button](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-start-here.png) +![Start collecting button](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/start-collecting-sep.png) ## Send Kubernetes data -### 1. Select your platform +### Select your environment -Select the platform through which you’d like to ship your data. Then, if required, select the relevant sub-type. -![Select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-collector-main-aug22.png) +Select the environment through which you’d like to ship your data. Then, if required, select the relevant sub-type. -### 2. Select data sources +![Select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-collector-main-sep.png) -Next, select the data sources. Hover over each source to see the type of data it collects and processes. +### Activate your collector -*You'll have to manually [define auto-instrumentation](https://docs.logz.io/user-guide/distributed-tracing/tracing-instrumentation) to collect your **Distributed Tracing** through Logz.io’s Telemetry Collector.* +Choose the platform on which you want to run the Telemetry Collector. You can choose between **Helm**, **Mac**, **Windows**, or **Linux**. -![Select data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-step-2.png) +* **Helm** users - Connect to the Kubernetes cluster from which you want to send telemetry, copy the Helm Install snippet, replace the placeholders with the relevant values, and run it in your terminal. +* **Mac** users - Copy the snippet and run it in your terminal. +* **Windows** users - Copy the snippet and run it in your PowerShell x64 **as Administrator** (Note that PowerShell x86 and PowerShell ISE are currently not supported). +* **Linux** users - Copy the snippet and run it in your command line. -### 3. Define your collector +:::note +Some platforms might require additional details, such as admin privileges or passwords to complete the installation. These details are not sent to or stored by Logz.io. +::: -Choose a name and write a description to help identify the collector. +![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/activate-collector-sep.png) -Under **Accounts**, you can review the Logs, Metrics, and Tracing accounts to which the Telemetry Collector will send the data. If you don't have an existing account, you'll be able to review the account's name before continuing. +### Run the Telemetry Collector -Click **Generate snippet** to continue. +The Telemetry Collector will create all setters needed for the Helm install command to install Logz.io Helm chart and deploy the chart with the relevant parameters. Once running, the Telemetry Collector will continuously collect the relevant data from your end, and you can view and manage it in Logz.io. -![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-step-3.png) +You can review the complete list of parameters and commands that Logz.io runs in the background [on the **Logzio Monitoring GitHub repository**](https://github.com/logzio/logzio-helm/tree/master/charts/logzio-monitoring). -Next, review your collector. The Summary, located on the left side of the screen, includes all of the data in the collector. +It might take a while for the Telemetry Collector to get up and running, after which you can view your logs, metrics, or traces and get full observability into your system. -### 4. Choose a platform +### Optional - Select data sources -Choose the platform on which you want to run the Telemetry Collector. You can choose between **Mac**, **Windows**, or **Linux**. +You can configure the data sources the Telemetry Collector will collect. To do so, click on **Advance settings** at the top of the page. Next, you can edit and change telemetries, which Logz.io will collect. -* **Mac** users - Copy the snippet and run it in your terminal. -* **Windows** users - Copy the snippet and run it in your PowerShell x64 **as Administrator** (Note that PowerShell x86 and PowerShell ISE are currently not supported). -* **Linux** users - Copy the snippet and run it in your command line. -:::note -Some platforms might require additional details, such as admin privileges or passwords to complete the installation. These details are not sent to or stored by Logz.io. -::: +![Select data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/select-data-sources-sep.png) -![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-snippet-last-step.png) -### 5. Run the Telemetry Collector + -The Telemetry Collector will create all setters needed for the Helm install command to install Logz.io Helm chart and deploy the chart with the relevant parameters. Once running, the Telemetry Collector will continuously collect the relevant data from your end, and you'll be able to view and manage it in Logz.io. -You can review the complete list of parameters and commands that Logz.io runs in the background [on the **Logzio Monitoring GitHub repository**](https://github.com/logzio/logzio-helm/tree/master/charts/logzio-monitoring). -### 6. Collect data +### Optional - Define your collector + +You can edit your collector’s name and description and choose which Logs, Metrics, and Tracing accounts to use. If you don’t have active accounts, you’ll be able to review the newly generated account names before continuing. + +Click **Save changes** to continue. + +![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/define-collector-sep.png) + -That’s it! It might take a while for the Telemetry Collector to get up and running, after which you’ll be able to view your logs, metrics, or traces and get full observability into your system. -## Manage your Telemetry Collector +## Manage your Telemetry Collector: To manage a Kubernetes Telemetry Collector, you can use the following commands: @@ -107,7 +112,7 @@ _Replace `<>` with your Windows user name._ If you have additional questions about managing your Telemetry Collector, [contact Logz.io's Support team](mailto:help@logz.io). -## Remove your Telemetry Collector +### Remove your Telemetry Collector: You can uninstall your Telemetry Collector from **Kubernetes** by running the following snippet in the same platform you've used to install it: @@ -123,6 +128,6 @@ This snippet removes the collector from Logz.io and stops sending your data. Of If you have additional questions about managing your Telemetry Collector, [contact Logz.io's Support team](mailto:help@logz.io). -###### Additional resources +## Additional resources * [View Telemetry Collector on GitHub](https://github.com/logzio/logzio-agent-manifest) \ No newline at end of file diff --git a/docs/user-guide/telemetry-collector/telemetry-collector-localhost.md b/docs/user-guide/telemetry-collector/telemetry-collector-localhost.md index 13b05b03..2bb8dfc1 100644 --- a/docs/user-guide/telemetry-collector/telemetry-collector-localhost.md +++ b/docs/user-guide/telemetry-collector/telemetry-collector-localhost.md @@ -1,6 +1,9 @@ --- sidebar_position: 4 title: Send Localhost Data with Telemetry Collector +image: https://dytvr9ot2sszz.cloudfront.net/logz-docs/social-assets/docs-social.jpg +description: Send your Localhost data with Logz.io's Telemetry Collector +keywords: [log-shipping, telemetry collector, localhost data, local host, agent, collector, mac, linux, windows] --- :::note @@ -14,52 +17,49 @@ To configure the Telemetry Collector, you must be logged into your **main** Logz ::: -![Start collecting button](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-start-here.png) +![Start collecting button](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/start-collecting-sep.png) ## Send Localhost data -### 1. Select platform +### Select your environment -Select the Localhost platform and the relevant sub-type through which you want to send your data. +Select your preferred Localhost platform through which you want to send your data. -![Localhost select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/tc-select-localhost.png) +![Localhost select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/collector-localhost-sep.png) -### 2. Select data sources +### Activate your collector -Enter the full path location of your log folders from your machine. You can add multiple log folders or files by clicking on the **Add a folder**/**Add a file** option. +Copy the code snippet and run it on your end: -The Telemetry Collector can also collect metrics data from your logs. +* **Windows** users - Run the snippet in your PowerShell x64 **as Administrator** (Note that PowerShell x86 and PowerShell ISE are currently not supported). +* **Linux** and **Mac** users - Run the snippet in your terminal. Note that your Bash version should be **4.0** or higher. -![Select folder collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/log-location.png) +Some platforms might require additional details, such as admin privileges or passwords, to complete the installation. These details are not sent to or stored by Logz.io. -If you're running on a **Windows** machine, you'll be able to choose whether you want to collect application, security, and system logs. +![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/activate-collector-localhost-sep.png) -### 3. Define your collector +It might take a while for the Telemetry Collector to get up and running, after which you can view your logs or metrics and get full observability into your system. -Choose a name and write a description to help identify the collector. +### _Optional_ - Select data sources -Under **Accounts**, you can review the Logs and Metrics accounts to which the Telemetry Collector will send the data. If you don’t have an existing account, one will be created for you, and you’ll be able to review its name before continuing. +You can configure the data sources the Telemetry Collector will collect. To do so, click on **Advance settings** at the top of the page. Next, you can edit and change telemetries, which Logz.io will collect. -Click **Generate snippet** to continue. +You can edit the path location of your log folders from your machine and choose which telemetries you want to collect. -![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/define-collector-localhost.png) +![Select folder collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/configure-localhost-sep.png) -### 4. Run the Telemetry Collector +If you're running on a **Windows** machine, you can choose whether you want to collect application, security, and system logs. -Copy the code snippet and run it on your end: +### _Optional_ - Define your collector -* **Mac** and **Linux** users - Run the snippet in your terminal. -* **Windows** users - Run the snippet in your PowerShell x64 **as Administrator** (Note that PowerShell x86 and PowerShell ISE are currently not supported). - -Some platforms might require additional details, such as admin privileges or passwords, to complete the installation. These details are not sent to or stored by Logz.io. +You can edit your collector’s name and description and choose which Logs, Metrics, and Tracing accounts to use. If you don’t have active accounts, you’ll be able to review the newly generated account names before continuing. -![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/collector-localhost-finish.png) +Click **Save changes** to continue. -### 5. Collect data +![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/define-localhost-sep.png) -That’s it! It might take a while for the Telemetry Collector to get up and running, after which you’ll be able to view your logs or metrics and get full observability into your system. If you encounter issues in installing or running your Telemetry Collector, [contact Logz.io's Support team](mailto:help@logz.io). @@ -109,6 +109,6 @@ To manage a Localhost Telemetry Collector on your **Windows** machine, you can u Replace `<>` with your Windows user name. If you have additional questions about managing your Telemetry Collector, [contact Logz.io's Support team](mailto:help@logz.io). -###### Additional resources +## Additional resources * [View Telemetry Collector on GitHub](https://github.com/logzio/logzio-agent-manifest) \ No newline at end of file