Skip to content

Commit 6234c6a

Browse files
himsharma01JV0812jpipkin1
authored
Load balancer app docs update (#5114)
* classic load balancer doc updated * Updating load balancer logs * Updates from review --------- Co-authored-by: Jagadisha V <[email protected]> Co-authored-by: John Pipkin <[email protected]>
1 parent d3995a3 commit 6234c6a

File tree

4 files changed

+102
-58
lines changed

4 files changed

+102
-58
lines changed

docs/integrations/amazon-aws/application-load-balancer.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -63,22 +63,20 @@ account="account" region="region" Namespace="AWS/ApplicationELB" loadbalancer="l
6363
```
6464

6565
## Collecting logs and metrics for the AWS Application Load Balancer
66+
When you create an AWS Source, you'll need to identify the Hosted Collector you want to use or create a new Hosted Collector. Once you create an AWS Source, associate it with a Hosted Collector. For instructions, see [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).
6667

67-
### Collecting Metrics
68+
### Collect metrics
6869

69-
Sumo Logic supports collecting metrics using two source types:
70+
1. Sumo Logic supports collecting metrics using two source types:
71+
* Configure an [AWS Kinesis Firehose for Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source) (recommended); or
72+
* Configure an [Amazon CloudWatch Source for Metrics](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics)
73+
1. **Metadata**. Click the **+Add Field** link to add custom log metadata [fields](/docs/manage/fields). Define the fields you want to associate, each field needs a name (key) and value.
74+
1. Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”.<br/><img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AWS-Lambda/Metadata.png')} alt="Metadata" style={{border: '1px solid gray'}} width="500" />
75+
1. Keep in mind:
76+
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
77+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
7078

71-
* Configure an [AWS Kinesis Firehose for Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source) (Recommended)
72-
Or
73-
* Configure an [Amazon CloudWatch Source for Metrics](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics)
74-
75-
:::note
76-
Namespace for AWS Application Load Balancer Service is AWS/ApplicationELB.
77-
:::
78-
79-
* **Metadata**. Add an **account** field to the source and assign it a value which is a friendly name or alias to your AWS account from which you are collecting metrics. This name will appear in the [AWS Observability view](/docs/dashboards/explore-view/#aws-observability). Metrics can be queried through the “account field”.<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AWS-Lambda/Metadata.png')} alt="Metadata" />
80-
81-
### Collecting Access Logs
79+
### Collect access logs
8280

8381
#### Prerequisites
8482

@@ -87,25 +85,41 @@ Before you begin to use the AWS Elastic Load Balancing (ELB) Application app, co
8785
2. [Enable Application Load Balancer logging](http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-access-logs.html#enable-access-logging) in AWS.
8886
3. Confirm that logs are being delivered to the Amazon S3 bucket.
8987

90-
#### Configure a Collector
88+
#### Collecting access Logs for AWS Application Load Balancer
9189

92-
Configure a [Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).
90+
1. Configure a Application Load Balancing (ALB) [Access Logs Source](/docs/send-data/hosted-collectors/amazon-aws/aws-sources/#create-an-aws-source).
91+
1. **Metadata**. Click the **+Add Field** link to add custom log metadata [fields](/docs/manage/fields). Define the fields you want to associate, each field needs a name (key) and value. The following **Fields** are to be added in the source:
92+
1. Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”.
93+
1. Add a **region** field and assign it the value of respective AWS region where the Load Balancer exists.
94+
1. Add an **accountId** field and assign it the value of the respective AWS account id which is being used.
95+
1. Keep in mind:
96+
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
97+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
9398

94-
#### Configure an ELB Source
99+
### Collect Cloudtrail logs
95100

96-
import Aws3 from '../../reuse/apps/create-aws-s3-source.md';
101+
1. Configure a Application Load Balancing (ALB) [Cloudtrail Logs Source](/docs/send-data/hosted-collectors/amazon-aws/aws-cloudtrail-source/).
102+
1. **Metadata**. Click the **+Add Field** link to add custom log metadata [Fields](/docs/manage/fields). Define the fields you want to associate, each field needs a name (key) and value.
103+
1. Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”.
104+
1. Keep in mind:
105+
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
106+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
97107

98-
<Aws3/>
108+
:::note
109+
Namespace for AWS Application Load Balancer Service is AWS/ApplicationELB.
110+
:::
99111

100-
### Field in Field Schema
112+
## Field in field schema
101113

102114
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
103115
1. Search for the `loadbalancer` field.
104116
1. If not present, create it. Learn how to create and manage fields [here](/docs/manage/fields.md#manage-fields).
105117

106-
### Field Extraction Rule(s)
118+
## Field Extraction Rule(s)
119+
120+
Create Field Extraction Rule (FER) for AWS Application Load Balancer access logs and Cloudtrail logs. Learn how to create a Field Extraction Rule [here](/docs/manage/field-extractions/create-field-extraction-rule).
107121

108-
Create Field Extraction Rule (FER) for AWS Application Load Balancer Access Logs. Learn how to create Field Extraction Rule [here](/docs/manage/field-extractions/create-field-extraction-rule).
122+
**AWS Application Load Balancer access logs**
109123

110124
```sql
111125
Rule Name: AwsObservabilityAlbAccessLogsFER
@@ -117,7 +131,7 @@ Scope (Specific Data): account=* region=* (http or https or h2 or grpcs or ws or
117131
parse "* * * * * * * * * * * * \"*\" \"*\" * * * \"*\"" as Type, DateTime, loadbalancer, Client, Target, RequestProcessingTime, TargetProcessingTime, ResponseProcessingTime, ElbStatusCode, TargetStatusCode, ReceivedBytes, SentBytes, Request, UserAgent, SslCipher, SslProtocol, TargetGroupArn, TraceId | tolowercase(loadbalancer) as loadbalancer | fields loadbalancer
118132
```
119133

120-
#### Create/Update Field Extraction Rule(s) for Application Load Balancer CloudTrail logs
134+
**AWS Application Load Balancer CloudTrail logs**
121135

122136
```sql
123137
Rule Name: AwsObservabilityALBCloudTrailLogsFER

docs/integrations/amazon-aws/classic-load-balancer.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -64,51 +64,66 @@ Statistic=Sum | sum by account, region, namespace, loadbalancername
6464

6565
## Collecting logs and metrics for the AWS Classic Load Balancer
6666

67-
### Collect Metrics for AWS Classic Load Balancer
67+
When you create an AWS Source, you'll need to identify the Hosted Collector you want to use or create a new Hosted Collector. Once you create an AWS Source, associate it with a Hosted Collector. For instructions, see [Configure a Hosted Collector and Source](/docs/send-data/hosted-collectors/configure-hosted-collector).
6868

69-
Sumo Logic supports collecting metrics using two source types
70-
* Configure an [AWS Kinesis Firehose for Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source) (Recommended); or
71-
* Configure an [Amazon CloudWatch Source for Metrics](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics)
69+
### Collect metrics
7270

73-
Namespace for **AWS Classic Load Balancer** Service is **AWS/ELB**.
74-
75-
* ​​​​**Metadata:** Add an **account** field to the source and assign it a value that is a friendly name/alias to your AWS account from which you are collecting metrics. This name will appear in the [AWS Observability view](/docs/dashboards/explore-view/#aws-observability). Metrics can be queried via the “account field”.
76-
77-
78-
### Collecting Access Logs for AWS Classic Load Balancer
79-
80-
#### Configure a Collector
81-
82-
See [Configure a Hosted Collector](/docs/send-data/hosted-collectors/configure-hosted-collector).
71+
1. Sumo Logic supports collecting metrics using two source types:
72+
* Configure an [AWS Kinesis Firehose for Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source) (recommended); or
73+
* Configure an [Amazon CloudWatch Source for Metrics](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics)
74+
1. **Metadata**. Click the **+Add Field** link to add custom log metadata [fields](/docs/manage/fields). Define the fields you want to associate, each field needs a name (key) and value.
75+
1. Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”.<br/><img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AWS-Lambda/Metadata.png')} alt="Metadata" style={{border: '1px solid gray'}} width="500" />
76+
1. Keep in mind:
77+
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
78+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
8379

80+
### Collect access logs
8481

8582
#### Prerequisites
8683

87-
Before you can begin to use the AWS Elastic Load Balancing (ELB) App, complete the following steps:
84+
Before you can begin to use the AWS Classic Load Balancing (ELB) App, complete the following steps:
8885

8986
1. [Grant Sumo Logic access](/docs/send-data/hosted-collectors/amazon-aws/grant-access-aws-product) to an Amazon S3 bucket.
9087
2. [Enable Application Load Balancer logging](http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-access-logs.html#enable-access-logging) in AWS.
9188
3. Confirm that logs are being delivered to the Amazon S3 bucket.
9289

90+
#### Collecting access logs for AWS Classic Load Balancer
91+
92+
1. Configure a Classic Load Balancing (CLB) [Access Logs Source](/docs/send-data/hosted-collectors/amazon-aws/aws-sources/#create-an-aws-source).
93+
1. **Metadata**. Click the **+Add Field** link to add custom log metadata [fields](/docs/manage/fields). Define the fields you want to associate, each field needs a name (key) and value. The following **Fields** are to be added in the source:
94+
1. Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”.
95+
1. Add a **region** field and assign it the value of respective AWS region where the Load Balancer exists.
96+
1. Add an **accountId** field and assign it the value of the respective AWS account id which is being used.
97+
1. Keep in mind:
98+
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
99+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
93100

94-
#### Configure an ELB Source
101+
### Collect Cloudtrail logs
95102

96-
import Aws3 from '../../reuse/apps/create-aws-s3-source.md';
103+
1. Configure a Classic Load Balancing (CLB) [Cloudtrail Logs Source](/docs/send-data/hosted-collectors/amazon-aws/aws-cloudtrail-source/).
104+
1. **Metadata**. Click the **+Add Field** link to add custom log metadata [fields](/docs/manage/fields). Define the fields you want to associate, each field needs a name (key) and value.
105+
1. Add an **account** field and assign it a value which is a friendly name / alias to your AWS account from which you are collecting logs. Logs can be queried via the “account field”.
106+
1. Keep in mind:
107+
* ![green check circle.png](/img/reuse/green-check-circle.png) A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
108+
* ![orange exclamation point.png](/img/reuse/orange-exclamation-point.png) An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
97109

98-
<Aws3/>
110+
:::note
111+
Namespace for **AWS Classic Load Balancer** Service is **AWS/ELB**.
112+
:::
99113

100-
### Field in Field Schema
114+
## Field in field schema
101115

102116
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Fields**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Logs** select **Fields**. You can also click the **Go To...** menu at the top of the screen and select **Fields**.
103117
1. Search for the **loadbalancername** field.
104118
1. If not present, create it. Learn how to create and manage fields [here](/docs/manage/fields#manage-fields).
105119

120+
## Field Extraction Rule(s)
106121

107-
### Field Extraction Rule(s)
122+
Create a Field Extraction Rule for AWS Classic Load Balancer access logs and Cloudtrail logs. Learn how to create Field Extraction Rules [here](/docs/manage/field-extractions/create-field-extraction-rule).
108123

109-
Create Field Extraction Rule for AWS Classic Load Balancer Access Logs. Learn how to create Field Extraction Rule [here](/docs/manage/field-extractions/create-field-extraction-rule).
124+
**AWS Classic Load Balancer access logs**
110125

111-
```sql
126+
```sql
112127
Rule Name: AwsObservabilityElbAccessLogsFER
113128
Applied at: Ingest Time
114129
Scope (Specific Data): account=* region=* _sourceCategory=aws/observability/clb/logs
@@ -122,7 +137,7 @@ Scope (Specific Data): account=* region=* _sourceCategory=aws/observability/clb/
122137
| fields loadbalancername, namespace
123138
```
124139

125-
#### Create/Update Field Extraction Rule(s) for Classic Load Balancer CloudTrail logs
140+
**AWS Classic Load Balancer CloudTrail Logs**
126141

127142
```sql
128143
Rule Name: AwsObservabilityCLBCloudTrailLogsFER

0 commit comments

Comments
 (0)