Skip to content

Commit

Permalink
Editing collector (#2470)
Browse files Browse the repository at this point in the history 
* editing collector

* edits

* remove a step

* more changes

* more changes

* edits
  • Loading branch information
@Simplychee
Simplychee authored Oct 11, 2023
1 parent e8bdd8f commit 1abbb67
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 67 deletions.
38 changes: 23 additions & 15 deletions ...user-guide/log-shipping/telemetry-collector-shipping/telemetry-collector-aws.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ 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.
{:.info-box.important}

![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

Expand All @@ -33,42 +33,50 @@ The IAM role assigned to the EC2 instance must include the `ec2:DescribeTags` pe

<div class="tasklist">

##### 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)

##### 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)

##### 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)


##### _Optional_ - Define your EC2 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.


![configure ec2 data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/configure-ec2-sep.png)

![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-aws-define.png)

##### Install the Telemetry Collector

Copy the code snippet and **run it in your EC2** to install the AWS 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}

![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/collector-localhost-finish.png)

##### 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.

</div>

Expand Down
56 changes: 28 additions & 28 deletions ...user-guide/log-shipping/telemetry-collector-shipping/telemetry-collector-k8s.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,65 +21,65 @@ 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**.

To configure the Telemetry Collector, you must be logged into your **main** Logz.io account.
{:.info-box.important}


![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)

<div class="tasklist">

##### 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.

![Select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-collector-main-aug22.png)
![Select platform](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-collector-main-sep.png)

##### Select data sources
##### Activate your collector

Next, select the data sources. Hover over each source to see the type of data it collects and processes.
Choose the platform on which you want to run the Telemetry Collector. You can choose between **Helm**, **Mac**, **Windows**, or **Linux**.

*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.*
* **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.

![Select data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-step-2.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.
{:.info-box.note}

##### Define your collector
![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/activate-collector-sep.png)

Choose a name and write a description to help identify the collector.
##### Run the Telemetry 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.
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.

Click **Generate snippet** to continue.
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).

![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-step-3.png)
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.

Next, review your collector. The Summary, located on the left side of the screen, includes all of the data in the collector.
##### Optional - Select data sources

##### Choose a platform
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.

Choose the platform on which you want to run the Telemetry Collector. You can choose between **Mac**, **Windows**, or **Linux**.

* **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.
![Select data source](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/select-data-sources-sep.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.
{:.info-box.note}

![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/telemetry-snippet-last-step.png)
<!-- *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.* -->

##### 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).
##### 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.

##### Collect data
![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.

</div>

Expand Down
44 changes: 20 additions & 24 deletions ...uide/log-shipping/telemetry-collector-shipping/telemetry-collector-localhost.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,52 +19,48 @@ To configure the Telemetry Collector, you must be logged into your **main** Logz
{:.info-box.important}


![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)


<div class="tasklist">

##### 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)

##### 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.

The Telemetry Collector can also collect metrics data from your logs.

![Select folder collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/log-location.png)
Copy the code snippet and run it on your end:

If you're running on a **Windows** machine, you'll be able to choose whether you want to collect application, security, and system 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.

##### Define 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.

Choose a name and write a description to help identify the collector.
![Review collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/activate-collector-localhost-sep.png)

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.
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.
##### _Optional_ - Select data sources

Click **Generate snippet** to continue.
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.

![Define collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/define-collector-localhost.png)
You can edit the path location of your log folders from your machine and choose which telemetries you want to collect.

##### Run the Telemetry Collector
![Select folder collector](https://dytvr9ot2sszz.cloudfront.net/logz-docs/telemetry-agent/configure-localhost-sep.png)

Copy the code snippet and run it on your end:
If you're running on a **Windows** machine, you can choose whether you want to collect application, security, and system logs.

* **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).
##### _Optional_ - Define 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.
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.

##### 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.

</div>

Expand Down

0 comments on commit 1abbb67

Please sign in to comment.