Skip to content

Commit cf538ca

Browse files
committed
Start adding images to send-data
1 parent 67552ea commit cf538ca

File tree

6 files changed

+46
-45
lines changed

6 files changed

+46
-45
lines changed

docs/send-data/collect-from-other-data-sources/amazon-msk-prometheus-metrics-collection.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ sidebar_label: Amazon MSK Prometheus
55
description: The Amazon Managed Streaming for Apache Kafka (Amazon MSK) open monitoring feature exposes Kafka metrics that Sumo Logic can collect. This page provides instructions for configuring metrics collection for Amazon MSK.
66
---
77

8+
import useBaseUrl from '@docusaurus/useBaseUrl';
89

910
**Amazon Managed Streaming for Apache Kafka (Amazon MSK)** Open Monitoring, exposes Kafka metrics to third-party sources to monitor and troubleshoot MSK clusters. This section provides instructions for configuring metrics collection for Amazon MSK.
1011

@@ -120,6 +121,6 @@ To start Telegraf and query new metrics, do the following:
120121

121122
1. Query for these new metrics in Sumo Logic by writing Metrics queries, as shown in the following example.
122123

123-
![AmazonMSK_Metric_Query.png](/img/send-data/AmazonMSK_Metric_Query.png)
124+
<img src={useBaseUrl('img/send-data/AmazonMSK_Metric_Query.png')} alt="Amazon metric query" style={{border: '1px solid gray'}} width="800" />
124125

125126
For more information on using Telegraf to get data into Sumo Logic, see this page on [collecting metrics with Telegraf](/docs/send-data/collect-from-other-data-sources/collect-metrics-telegraf). 

docs/send-data/collect-from-other-data-sources/autosubscribe-arn-destination.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ sidebar_label: Amazon Resource Names (ARNs)
55
description: You can use an Amazon CloudWatch Log Group subscription to access log events from CloudWatch Logs in real time, and send them to Sumo Logic.
66
---
77

8+
import useBaseUrl from '@docusaurus/useBaseUrl';
89

910
You can use an [Amazon CloudWatch Log Group subscription](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/SubscriptionFilters.html) to collect log events from CloudWatch Logs in real-time, and send them to Sumo Logic. 
1011

@@ -28,7 +29,7 @@ To deploy LogGroup Lambda Connector, do the following:
2829
1. In the Serverless Application Repository, search for **sumologic**.
2930
1. Select **Show apps that create custom IAM roles or resource policies** check box.
3031
1. Click the **sumologic-loggroup-connector**,link, and then click **Deploy**.
31-
1. In the **AWS Lambda > Functions > Application Settings** panel, configure the parameters as described in [configuring parameters](#configuringparameters) section below. <br/> ![Deploy_LogGroup_Connector.png](/img/send-data/Auto-Subscribe_AWS_ARN_Destination-ApplicationSettings.png)
32+
1. In the **AWS Lambda > Functions > Application Settings** panel, configure the parameters as described in [configuring parameters](#configuringparameters) section below. <br/><img src={useBaseUrl('img/send-data/Auto-Subscribe_AWS_ARN_Destination-ApplicationSettings.png')} alt="Deploy log group detector" style={{border: '1px solid gray'}} width="800" />
3233
1. Click the checkbox to acknowledge that the template creates IAM resources.
3334
1. Scroll to the bottom of the window and click **Deploy**. After a few minutes, **CREATE_COMPLETE** should appear in the status column corresponding to all resources in the Resources section.
3435
1. [Test the Lambda function](#testing-the-lambda-function).
@@ -43,11 +44,11 @@ This section describes the parameters you can configure for the Lambda function.
4344

4445
* **Lambda**: Enter the Amazon Resource Name (ARN) of the target Lambda function, that will receive CloudWatch logs via the Log Group subscription. To find a function's ARN, open the AWS Lambda console, and select the function from the list. A function's ARN is shown in the upper right corner of the page. 
4546

46-
![AWS_Lambda-function-parameters.png](/img/send-data/AWS_Lambda-function-parameters.png)
47+
<img src={useBaseUrl('img/send-data/AWS_Lambda-function-parameters.png')} alt="AWS Lambda function parameters" style={{border: '1px solid gray'}} width="800" />
4748

4849
* **Kinesis**: Enter the Amazon Resource Name (ARN) of the target Amazon Kinesis firehose data Delivery Stream (the stream that will receive the CloudWatch Logs via the log group subscription). To find the ARN, open the Kinesis console, and select the delivery stream from the data firehose section. A delivery stream ARN is shown in the **Delivery Stream ARN** parameter. 
4950

50-
![delivery-arn-parameter](/img/send-data/delivery-arn-parameter.png)
51+
<img src={useBaseUrl('img/send-data/delivery-arn-parameter.png')} alt="Delivery ARN parameter" style={{border: '1px solid gray'}} width="800" />
5152

5253
* **LogGroupPattern**—A Javascript regex to filter Log Groups. Log Groups that match the regular expression will be subscribed to the connector. Matching is case-insensitive. The placeholder regex Test matches testlogroup, logtestgroup, and LogGroupTest. Replace Test with a  Javascript regular expression that filters your Log Groups as desired.
5354

@@ -96,9 +97,9 @@ This section demonstrates how to test the Lambda function to ensure that the Con
9697
9798
To test the Lambda function, do the following:
9899
99-
1. Create a Log Group with a name that matches the regex you specified for **LogGroupPattern**<br/>![AWS_LambdaFunction_LoggroupPattern.png](/img/send-data/AWS_LambdaFunction_LoggroupPattern.png)
100+
1. Create a Log Group with a name that matches the regex you specified for **LogGroupPattern**<br/><img src={useBaseUrl('img/send-data/AWS_LambdaFunction_LoggroupPattern.png')} alt="Log group pattern" style={{border: '1px solid gray'}} width="800" />
100101
101-
After a few seconds, the Log Group should be subscribed to the Destination AWS Resource whose ARN you specified in the `DESTINATION_ARN` environment variable. <br/>![AWS_LambdaFunction_Loggroup-specified.png](/img/send-data/AWS_LambdaFunction_Loggroup-specified.png)
102+
After a few seconds, the Log Group should be subscribed to the Destination AWS Resource whose ARN you specified in the `DESTINATION_ARN` environment variable. <br/><img src={useBaseUrl('img/send-data/AWS_LambdaFunction_Loggroup-specified.png')} alt="AWS Lambda function" style={{border: '1px solid gray'}} width="800" />
102103
103104
1. View the logs of Lambda function. You can view the logs generated by `SumoLogGroupLambdaConnector-<unique_string>` in CloudWatch in the `/aws/lambda/SumoLogGroupLambdaConnector-<unique_string>` log group.
104105
1. (Optional) Continue with [troubleshooting the connector.](#troubleshooting-the-connector)

docs/send-data/collect-from-other-data-sources/aws-fargate-log-collection.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sidebar_label: AWS ECS Fargate
55
description: This page describes how to collect application container logs from AWS ECS Fargate and EC2 using AWS Firelens.
66
---
77

8+
import useBaseUrl from '@docusaurus/useBaseUrl';
9+
810
This page describes how to collect application container logs from AWS ECS clusters launched with AWS Fargate using AWS FireLens. This method also works with ECS clusters with EC2 containers. However, the recommended method for collecting EC2 logs is to utilize the [Docker logging driver](docker-collection-methods.md).
911

1012

@@ -17,7 +19,7 @@ This page describes how to collect application container logs from AWS ECS clust
1719

1820
The following diagram illustrates the process for sending container logs from ECS containers running on AWS Fargate or EC2 to Sumo Logic using the FireLens log driver.
1921

20-
![Fargate-EC2_collection_process1.png](/img/send-data/Fargate-EC2_collection_process1.png)
22+
<img src={useBaseUrl('img/send-data/Fargate-EC2_collection_process1.png')} alt="Fargate EC2 collection process" style={{border: '1px solid gray'}} width="800" />
2123

2224
Firelens allows you to configure Fluentd or Fluent Bit output in your Fargate task definition. Fluent Bit is the recommended option because its resource utilization is significantly lower than Fluentd.
2325

@@ -222,7 +224,7 @@ This task is optional. If you want to create a centralized Fluentd aggregator
222224

223225
The following diagram illustrates the centralized Fluentd collection process.
224226

225-
![Fargate-EC2_collection_process2.png](/img/send-data/Fargate-EC2_collection_process2.png)
227+
<img src={useBaseUrl('img/send-data/Fargate-EC2_collection_process2.png')} alt="Fargate EC2 collection process continued" style={{border: '1px solid gray'}} width="800" />
226228

227229
To create a centralized Fluentd aggregator, do the following:
228230

docs/send-data/collect-from-other-data-sources/collect-aws-lambda-logs-extension.md

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ sidebar_label: AWS Lambda Extension
55
description: Learn to collect the AWS Lambda logs through an extension.
66
---
77

8+
import useBaseUrl from '@docusaurus/useBaseUrl';
9+
810
[AWS Lambda Extensions](https://aws.amazon.com/blogs/compute/introducing-aws-lambda-extensions-in-preview/) enable us to more easily integrate into the AWS Lambda execution environment to control and participate in the AWS Lambda lifecycle and the AWS Lambda Telemetry API enables us to collect AWS Lambda logs, metrics, and spans. Sumo Logic, therefore, has developed a new open-source AWS Lambda extension that is a lightweight process that runs within the same execution environment as your Lambda functions and uses the Lambda Telemetry API to send platform, function, and extension logs along with metrics and spans to Sumo Logic. Sumo Logic's Lambda Extension works with AWS Lambda functions that are built for both x86_64 and ARM 64 (Graviton2) architectures.
911

10-
![LambdaExtension.png](/img/send-data/LambdaExtension.png)
12+
<img src={useBaseUrl('img/send-data/LambdaExtension.png')} alt="Lambda extension" style={{border: '1px solid gray'}} width="800" />
1113

1214
To learn more please see the following links:
1315

@@ -50,7 +52,7 @@ For AWS Lambda functions created using Zip files, blueprint or serverless applic
5052

5153
To add the Sumo Logic Lambda Extension to your AWS Lambda function, please follow the steps below:
5254

53-
1. In the AWS Management Console, navigate to the definition of your Lambda function, Select **Layers** and click **Add a Layer**. <br/> ![Add_Layer.png](/img/send-data/Add_Layer.png)
55+
1. In the AWS Management Console, navigate to the definition of your Lambda function, Select **Layers** and click **Add a Layer**. <br/><img src={useBaseUrl('img/send-data/Add_Layer.png')} alt="Add layer" style={{border: '1px solid gray'}} width="800" />
5456

5557
1. Select **Specify an ARN**.
5658

@@ -63,7 +65,7 @@ To add the Sumo Logic Lambda Extension to your AWS Lambda function, please follo
6365
* **AWS_REGION.** Replace with the AWS Region of your Lambda function
6466
* **VERSION.** The latest version of the Sumo Logic Extension.
6567
66-
![x86_64.png](/img/send-data/x86_64.png)
68+
<img src={useBaseUrl('img/send-data/x86_64.png')} alt="x86_64 architecture" style={{border: '1px solid gray'}} width="800" />
6769
6870
* For **arm64 architecture,** enter the following ARN:
6971
@@ -74,7 +76,7 @@ To add the Sumo Logic Lambda Extension to your AWS Lambda function, please follo
7476
* **AWS_REGION.** Replace with the AWS Region of your Lambda function
7577
* **VERSION.** The latest version of the Sumo Logic Extension.
7678
77-
![arm64.png](/img/send-data/arm64.png)
79+
<img src={useBaseUrl('img/send-data/arm64.png')} alt="arm64" style={{border: '1px solid gray'}} width="800" />
7880
7981
### AWS Lambda Functions Created Container Images
8082
@@ -108,7 +110,7 @@ To package the Sumo Logic Lambda Extension with the AWS Lambda function created
108110
docker run -it --entrypoint sh <ImageName>:<ImageTag>
109111
```
110112

111-
1. Execute the command `ls -R /opt/` to see the directory structure. It should look as per the screenshot below. <br/> ![Container_Images.png](/img/send-data/Container_Images.png)
113+
1. Execute the command `ls -R /opt/` to see the directory structure. It should look as per the screenshot below. <br/><img src={useBaseUrl('img/send-data/Container_Images.png')} alt="Container images" style={{border: '1px solid gray'}} width="600" />
112114

113115
1. Deploy your AWS Lambda function using the container images.
114116

@@ -140,42 +142,37 @@ Add the following environment variables to your Lambda function:
140142

141143
### Using KMS to secure the SUMO_HTTP_ENDPOINT
142144
1. Follow the **Security in transit**
143-
" section in AWS [docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars-encryption.html) to encrypt the `SUMO_HTTP_ENDPOINT` environment variable. You can use **Symmetric** `Key type` with **Encrypt and decrypt** `Key usage`.
144-
![KMSKeycreationstep1.png](/img/send-data/KMSKeycreationstep1.png)
145-
1. Make sure to add Lambda's role as **Key Users** to allow your lambda function to use the key.
146-
![AddLambdaRolestep2.png](/img/send-data/AddLambdaRolestep2.png)
147-
1. In **Edit environment variables** section, add `KMS_KEY_ID` environment variable with value as KMS key ARN of the "Customer managed key" created earlier, you can obtain it from the [AWS console](https://docs.aws.amazon.com/kms/latest/developerguide/find-cmk-id-arn.html). Also encrypt the `SUMO_HTTP_ENDPOINT` using the same KMS key by clicking **Encrypt** button. It will replace the endpoint with the base64 encoded string.
148-
![AddLambdaEnvironmentVariableStep3.png](/img/send-data/AddLambdaEnvironmentVariableStep3.png)
145+
" section in AWS [docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars-encryption.html) to encrypt the `SUMO_HTTP_ENDPOINT` environment variable. You can use **Symmetric** `Key type` with **Encrypt and decrypt** `Key usage`. <br/><img src={useBaseUrl('img/send-data/KMSKeycreationstep1.png')} alt="KMS key creation" style={{border: '1px solid gray'}} width="800" />
146+
1. Make sure to add Lambda's role as **Key Users** to allow your lambda function to use the key.<br/><img src={useBaseUrl('img/send-data/AddLambdaRolestep2.png')} alt="Add Lambda role" style={{border: '1px solid gray'}} width="800" />
147+
1. In **Edit environment variables** section, add `KMS_KEY_ID` environment variable with value as KMS key ARN of the "Customer managed key" created earlier, you can obtain it from the [AWS console](https://docs.aws.amazon.com/kms/latest/developerguide/find-cmk-id-arn.html). Also encrypt the `SUMO_HTTP_ENDPOINT` using the same KMS key by clicking **Encrypt** button. It will replace the endpoint with the base64 encoded string.<br/><img src={useBaseUrl('img/send-data/AddLambdaEnvironmentVariableStep3.png')} alt="Add Lambda environment variable" style={{border: '1px solid gray'}} width="800" />
149148

150149

151150
1. Once you have set your parameters, execute your AWS Lambda function, and validate that the logs are coming into Sumo Logic.
152151
1. If you have enabled failover, do the following:
153152

154-
* Add the following inline policy to the IAM role associated with your lambda function.
155-
156-
![Inline_Policy.png](/img/send-data/Inline_Policy.png)
157-
158-
```
159-
{
160-
"Version": "2012-10-17",
161-
"Statement": [
162-
{
163-
"Sid": "VisualEditor0",
164-
"Effect": "Allow",
165-
"Action": "s3:PutObject",
166-
"Resource": "arn:aws:s3:::<AWS S3 Bucket Name>/*"
167-
}
168-
]
169-
}
170-
```
153+
* Add the following inline policy to the IAM role associated with your lambda function. <br/><img src={useBaseUrl('img/send-data/Inline_Policy.png')} alt="Inline policy" style={{border: '1px solid gray'}} width="800" />
154+
155+
```
156+
{
157+
"Version": "2012-10-17",
158+
"Statement": [
159+
{
160+
"Sid": "VisualEditor0",
161+
"Effect": "Allow",
162+
"Action": "s3:PutObject",
163+
"Resource": "arn:aws:s3:::<AWS S3 Bucket Name>/*"
164+
}
165+
]
166+
}
167+
```
171168
172169
* Configure a [Sumo Logic Amazon S3](../hosted-collectors/amazon-aws/aws-s3-source.md) source with the same source category as that of the HTTP Source created in Step 1 to read from this bucket.
173170
174-
:::note
175-
Logs from the Sumo Logic Lambda extension are stored and compressed in the following prefix path `sumologic-extension/<aws-region>/<Function>/<Version>/<Year>/<Month>/<Day>/<Hour>/<Min>/<UUID>.gz`
176-
:::
171+
:::note
172+
Logs from the Sumo Logic Lambda extension are stored and compressed in the following prefix path `sumologic-extension/<aws-region>/<Function>/<Version>/<Year>/<Month>/<Day>/<Hour>/<Min>/<UUID>.gz`
173+
:::
177174
178-
![Sumo_AWS_source.png](/img/send-data/Sumo_AWS_source.png)
175+
<img src={useBaseUrl('img/send-data/Sumo_AWS_source.png')} alt="Sumo Logic AWS source" style={{border: '1px solid gray'}} width="800" />
179176
180177
## Step 4 (Optional): Disable logging to CloudWatch logs
181178

docs/send-data/collector-faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -505,11 +505,11 @@ In this scenario, there is no time zone in the sample message at all. However, t
505505
506506
If you are experiencing apparent delays during ingest (receiving data), select the "Use Receipt Time" check box under the time picker. This will present data in the order in which it was received by Sumo, as well as display the timestamp that has been detected/applied.
507507
508-
![UseReceiptTime_chekcbox.png](/img/send-data/UseReceiptTime_chekcbox.png)
508+
<img src={useBaseUrl('img/send-data/UseReceiptTime_chekcbox.png')} alt="Use receipt time checkbox" style={{border: '1px solid gray'}} width="800" />
509509
510510
A gap between the two values indicates a potential misconfiguration of the time zone setting, particularly when the gap is (nearly) a multiple of hours, such as in the following example.
511511
512-
![TimeDiscrepancy.png](/img/send-data/TimeDiscrepancy.png)
512+
<img src={useBaseUrl('img/send-data/TimeDiscrepancy.png')} alt="Time discrepancy" style={{border: '1px solid gray'}} width="500" />
513513
514514
Review your time zone settings, and apply a time zone on the Source that reflects what the time zone is of the sending application. For example, if your application is sending events with a UTC timestamp, you can specify this in the Source configuration.
515515
@@ -601,7 +601,7 @@ To view Source settings:
601601
1. Click **Edit** to the right of the Source's name.
602602
1. Under **Advanced**, choose one of the following:
603603
604-
![img](/img/send-data/timezone_parsing_options.png)
604+
<img src={useBaseUrl('img/send-data/timezone_parsing_options.png')} alt="Time zone parsing options" style={{border: '1px solid gray'}} width="500" />
605605
606606
* Extract timestamp information from log file entries. Select this option if you'd like Sumo Logic to always extract timestamps from log messages. If no timestamp is detected, Sumo Logic uses the time when the data is received. Generally, this is the best option (it's also selected by default).
607607
* Use time zone from log file. Choose a time zone that Sumo Logic can use if log files do not have a time stamp. If a Collector is running on a computer set to the UTC time zone without an offset, Sumo Logic will use this time zone.

docs/send-data/setup-wizard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Before you begin, [sign up](/docs/get-started/sign-up.md) for a Sumo Logic accou
1717

1818
To open the Setup Wizard, in the [Classic UI](/docs/get-started/sumo-logic-ui-classic/) select **Manage Data > Collection > Collection**, and then click the **Setup Wizard** link on the top right of the Collection page.
1919

20-
<img src={useBaseUrl('img/get-started/setup-wizard.png')} alt="setup-wizard" />
20+
<img src={useBaseUrl('img/get-started/setup-wizard.png')} alt="Setup Wizard" style={{border: '1px solid gray'}} width="700" />
2121

2222
:::note
2323
Keyboard shortcuts are not available when the Setup Wizard is open.
@@ -54,7 +54,7 @@ The following file types are **not** supported:
5454

5555
To register an Installed Collector with the Setup Wizard:
5656

57-
1. Select the **Setup Wizard Token** authentication option. The Setup Wizard does not provide an option for Installation Tokens.<br/> ![wizard authentication step.png](/img/security/installation-tokens/wizard-authentication.png)
57+
1. Select the **Setup Wizard Token** authentication option. The Setup Wizard does not provide an option for Installation Tokens.<br/><img src={useBaseUrl('img/security/installation-tokens/wizard-authentication.png')} alt="Wizard authentication step" style={{border: '1px solid gray'}} width="600" />
5858
1. Click next.
5959
1. In the input box, enter the **Token String** you want to use to register the Collector for a one-time token.
6060
1. Continue with the installation steps.

0 commit comments

Comments
 (0)