Skip to content

Commit dc69ca6

Browse files
kaiyan-shengkaiyan-sheng
committed
Add documentation
1 parent 94be9a6 commit dc69ca6

File tree

3 files changed

+74
-11
lines changed

3 files changed

+74
-11
lines changed

‎packages/awsfirehose/_dev/build/docs/README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Amazon Data Firehose
2-
Amazon Data Firehose integration offers users a way to stream logs from Firehose to Elastic Cloud.
3-
This integration includes predefined rules that automatically route AWS service logs to the respective integrations, which
4-
include field mappings, ingest pipelines, predefined dashboards and ect. Here is a list of log types that are supported
5-
by this integration:
2+
Amazon Data Firehose integration offers users a way to stream logs and CloudWatch metrics from Firehose to Elastic Cloud.
3+
This integration includes predefined rules that automatically route AWS service logs and CloudWatch metrics to the respective integrations, which
4+
include field mappings, ingest pipelines, predefined dashboards and ect.
5+
6+
Here is a list of log types that are supported by this integration:
67

78
| AWS service log | Log destination |
89
|--------------------|--------------------------|
@@ -17,6 +18,31 @@ by this integration:
1718
| VPC Flow | Firehose, CloudWatch, S3 |
1819
| WAF | Firehose, CloudWatch. S3 |
1920

21+
Here is a list of CloudWatch metrics that are supported by this integration:
22+
23+
| AWS service monitoring metrics |
24+
|--------------------------------|
25+
| API Gateway |
26+
| DynamoDB |
27+
| EBS |
28+
| EC2 |
29+
| ECS |
30+
| ELB |
31+
| EMR |
32+
| Network Firewall |
33+
| Kafka |
34+
| Kinesis |
35+
| Lambda |
36+
| NATGateway |
37+
| RDS |
38+
| S3 |
39+
| S3 Storage Lens |
40+
| SNS |
41+
| SQS |
42+
| TransitGateway |
43+
| Usage |
44+
| VPN |
45+
2046
## Limitation
2147
It is not possible to configure a delivery stream to send data to Elastic Cloud via PrivateLink (VPC endpoint).
2248
This is a current limitation in Firehose, which we are working with AWS to resolve.
@@ -91,6 +117,12 @@ This is a current limitation in Firehose, which we are working with AWS to resol
91117
This parameter will increase the data volume in Elasticsearch and should be used with care.
92118

93119
3. Send data to the Firehose delivery stream
94-
120+
1. logs
95121
Consult the [AWS documentation](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html) for details on how to
96122
configure a variety of log sources to send data to Firehose delivery streams.
123+
124+
2. metrics
125+
Consult the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-setup.html)
126+
for details on how to set up a metric stream in CloudWatch and
127+
[Custom setup with Firehose](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-setup-datalake.html)
128+
to send metrics to Firehose. For Elastic, we only support JSON and OpenTelemetry 1.0.0 formats for the metrics.

‎packages/awsfirehose/data_stream/metrics/fields/fields.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
description: |
2424
Metric dimensions.
2525
dimension: true
26-
subobjects: false
2726
- name: firehose
2827
type: group
2928
fields:

‎packages/awsfirehose/docs/README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Amazon Data Firehose
2-
Amazon Data Firehose integration offers users a way to stream logs from Firehose to Elastic Cloud.
3-
This integration includes predefined rules that automatically route AWS service logs to the respective integrations, which
4-
include field mappings, ingest pipelines, predefined dashboards and ect. Here is a list of log types that are supported
5-
by this integration:
2+
Amazon Data Firehose integration offers users a way to stream logs and CloudWatch metrics from Firehose to Elastic Cloud.
3+
This integration includes predefined rules that automatically route AWS service logs and CloudWatch metrics to the respective integrations, which
4+
include field mappings, ingest pipelines, predefined dashboards and ect.
5+
6+
Here is a list of log types that are supported by this integration:
67

78
| AWS service log | Log destination |
89
|--------------------|--------------------------|
@@ -17,6 +18,31 @@ by this integration:
1718
| VPC Flow | Firehose, CloudWatch, S3 |
1819
| WAF | Firehose, CloudWatch. S3 |
1920

21+
Here is a list of CloudWatch metrics that are supported by this integration:
22+
23+
| AWS service monitoring metrics |
24+
|--------------------------------|
25+
| API Gateway |
26+
| DynamoDB |
27+
| EBS |
28+
| EC2 |
29+
| ECS |
30+
| ELB |
31+
| EMR |
32+
| Network Firewall |
33+
| Kafka |
34+
| Kinesis |
35+
| Lambda |
36+
| NATGateway |
37+
| RDS |
38+
| S3 |
39+
| S3 Storage Lens |
40+
| SNS |
41+
| SQS |
42+
| TransitGateway |
43+
| Usage |
44+
| VPN |
45+
2046
## Limitation
2147
It is not possible to configure a delivery stream to send data to Elastic Cloud via PrivateLink (VPC endpoint).
2248
This is a current limitation in Firehose, which we are working with AWS to resolve.
@@ -91,6 +117,12 @@ This is a current limitation in Firehose, which we are working with AWS to resol
91117
This parameter will increase the data volume in Elasticsearch and should be used with care.
92118

93119
3. Send data to the Firehose delivery stream
94-
120+
1. logs
95121
Consult the [AWS documentation](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html) for details on how to
96122
configure a variety of log sources to send data to Firehose delivery streams.
123+
124+
2. metrics
125+
Consult the [AWS documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-setup.html)
126+
for details on how to set up a metric stream in CloudWatch and
127+
[Custom setup with Firehose](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-setup-datalake.html)
128+
to send metrics to Firehose. For Elastic, we only support JSON and OpenTelemetry 1.0.0 formats for the metrics.

0 commit comments

Comments
 (0)