-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #227 from logzio/updates-from-old-doc-oct17
Updates from old doc oct17
- Loading branch information
Showing
4 changed files
with
117 additions
and
82 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| ::: | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ## 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. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ### 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. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ### 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. | ||
|  | ||
|
|
||
|  | ||
|
|
||
| ### 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. | ||
| ::: | ||
|
|
||
|  | ||
|  | ||
|
|
||
|
|
||
| ### 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 | ||
|  | ||
|
|
||
| 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:[email protected]). | ||
|
|
||
|
|
||
| ###### Additional resources | ||
| ## Additional resources | ||
|
|
||
| * [View Telemetry Collector on GitHub](https://github.com/logzio/logzio-agent-manifest) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| ::: | ||
|
|
||
|
|
||
|  | ||
|  | ||
|
|
||
| ## 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 the environment through which you’d like to ship your data. Then, if required, select the relevant sub-type. | ||
|
|
||
| ### 2. Select data sources | ||
|  | ||
|
|
||
| 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**. | ||
|
|
||
|  | ||
| * **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. | ||
|  | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
| 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. | ||
| ::: | ||
|  | ||
|
|
||
|  | ||
|
|
||
| ### 5. Run the Telemetry 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.* --> | ||
|
|
||
| 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. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 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 `<<USERNAME>>` with your Windows user name._ | |
| If you have additional questions about managing your Telemetry Collector, [contact Logz.io's Support team](mailto:[email protected]). | ||
|
|
||
|
|
||
| ## 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:[email protected]). | ||
|
|
||
|
|
||
| ###### Additional resources | ||
| ## Additional resources | ||
|
|
||
| * [View Telemetry Collector on GitHub](https://github.com/logzio/logzio-agent-manifest) | ||
Oops, something went wrong.