diff --git a/packages/aws/_dev/build/docs/apigateway.md b/packages/aws/_dev/build/docs/apigateway.md new file mode 100644 index 00000000000..d68451b94f2 --- /dev/null +++ b/packages/aws/_dev/build/docs/apigateway.md @@ -0,0 +1,46 @@ +# AWS API Gateway + +The AWS API Gateway integration allows you to monitor [API Gateway](https://aws.amazon.com/api-gateway/) — a centralized API management service. + +Use the AWS API Gateway integration to collect metrics related to your HTTP, REST or WebSockets APIs. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference metrics when troubleshooting an issue. + +For example, you could use this integration to examine metrics related to error rates, response codes, and latency. You can pinpoint problematic areas, identify error-prone API endpoints, and troubleshoot performance issues. + +**IMPORTANT: Extra AWS charges on AWS API requests will be generated by this integration. Please refer to the AWS integration for more details.** + +## Data streams + +The API Gateway integration collects one type of data: metrics. + +**Metrics** give you insight into the state of API Gateway. +Metrics collected by the AWS API Gateway integration include the number of client and server errors, request and error counts and cache counts. + +See more details in the [Metrics reference](#metrics-reference). + +## Requirements + +You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. +You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your hardware. + +Before using any AWS integration you will need: + +* **AWS Credentials** to connect with your AWS account. +* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data. + +For more details about these requirements, please take a look at the **AWS** integration documentation. + +## Setup + +Use this integration if you only need to collect data from the AWS API Gateway service. + +If you want to collect data from two or more AWS services, consider using the **AWS** integration. +When you configure the AWS integration, you can collect data from as many AWS services as you'd like. + +For step-by-step instructions on how to set up an integration, see the +{{ url "getting-started-observability" "Getting started" }} guide. + +## Metrics reference + +{{event "apigateway_metrics"}} + +{{fields "apigateway_metrics"}} \ No newline at end of file diff --git a/packages/aws/changelog.yml b/packages/aws/changelog.yml index 8d91c889c2a..83b87db9f2d 100644 --- a/packages/aws/changelog.yml +++ b/packages/aws/changelog.yml @@ -1,4 +1,9 @@ # newer versions go on top +- version: "1.39.0" + changes: + - description: Add AWS API Gateway data stream. + type: enhancement + link: https://github.com/elastic/integrations/pull/6188 - version: "1.38.4" changes: - description: Add dimension fields to billing, sns and sqs data streams. diff --git a/packages/aws/data_stream/apigateway_metrics/agent/stream/stream.yml.hbs b/packages/aws/data_stream/apigateway_metrics/agent/stream/stream.yml.hbs new file mode 100644 index 00000000000..0f858a0d430 --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/agent/stream/stream.yml.hbs @@ -0,0 +1,63 @@ +metricsets: ["cloudwatch"] +period: {{period}} +{{#if data_granularity}} +data_granularity: {{data_granularity}} +{{/if}} +{{#if access_key_id}} +access_key_id: {{access_key_id}} +{{/if}} +{{#if secret_access_key}} +secret_access_key: {{secret_access_key}} +{{/if}} +{{#if session_token}} +session_token: {{session_token}} +{{/if}} +{{#if credential_profile_name}} +credential_profile_name: {{credential_profile_name}} +{{/if}} +{{#if shared_credential_file}} +shared_credential_file: {{shared_credential_file}} +{{/if}} +{{#if role_arn}} +role_arn: {{role_arn}} +{{/if}} +{{#if default_region}} +default_region: {{default_region}} +{{/if}} +{{#if regions}} +regions: +{{#each regions as |region i|}} +- {{region}} +{{/each}} +{{/if}} +{{#if latency}} +latency: {{latency}} +{{/if}} +{{#if tags_filter}} +tags_filter: {{tags_filter}} +{{/if}} +{{#if proxy_url }} +proxy_url: {{proxy_url}} +{{/if}} +metrics: +- namespace: AWS/ApiGateway + statistic: ["Sum"] + name: + - 4XXError + - 4xx + - 5XXError + - 5xx + - CacheHitCount + - CacheMissCount + - Count + - ConnectCount + - MessageCount + - IntegrationError + - ClientError + - ExecutionError +- namespace: AWS/ApiGateway + statistic: ["Average"] + name: + - Latency + - IntegrationLatency + - DataProcessed \ No newline at end of file diff --git a/packages/aws/data_stream/apigateway_metrics/fields/agent.yml b/packages/aws/data_stream/apigateway_metrics/fields/agent.yml new file mode 100644 index 00000000000..13e13903cc4 --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/fields/agent.yml @@ -0,0 +1,35 @@ +- name: cloud + title: Cloud + group: 2 + description: Fields related to the cloud or infrastructure the events are coming from. + footnote: 'Examples: If Metricbeat is running on an EC2 host and fetches data from its host, the cloud info contains the data about this machine. If Metricbeat runs on a remote machine outside the cloud and fetches data from a service running in the cloud, the field contains cloud data from the machine the service is running on.' + type: group + fields: + - name: image.id + type: keyword + description: Image ID for the cloud instance. +- name: host + title: Host + group: 2 + description: 'A host is defined as a general computing instance. + + ECS host.* fields should be populated with details about the host on which the event happened, or from which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.' + type: group + fields: + - name: containerized + type: boolean + description: > + If the host is a container. + + - name: os.build + type: keyword + example: "18D109" + description: > + OS build information. + + - name: os.codename + type: keyword + example: "stretch" + description: > + OS codename, if any. + diff --git a/packages/aws/data_stream/apigateway_metrics/fields/base-fields.yml b/packages/aws/data_stream/apigateway_metrics/fields/base-fields.yml new file mode 100644 index 00000000000..3f722e145db --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/fields/base-fields.yml @@ -0,0 +1,20 @@ +- name: data_stream.type + type: constant_keyword + description: Data stream type. +- name: data_stream.dataset + type: constant_keyword + description: Data stream dataset. +- name: data_stream.namespace + type: constant_keyword + description: Data stream namespace. +- name: '@timestamp' + type: date + description: Event timestamp. +- name: event.module + type: constant_keyword + description: Event module + value: aws +- name: event.dataset + type: constant_keyword + description: Event dataset + value: aws.apigateway_metrics \ No newline at end of file diff --git a/packages/aws/data_stream/apigateway_metrics/fields/ecs.yml b/packages/aws/data_stream/apigateway_metrics/fields/ecs.yml new file mode 100644 index 00000000000..20f154e37bd --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/fields/ecs.yml @@ -0,0 +1,62 @@ +- external: ecs + name: cloud +- external: ecs + name: cloud.account.id +- external: ecs + name: cloud.account.name +- external: ecs + name: cloud.availability_zone +- external: ecs + name: cloud.instance.id +- external: ecs + name: cloud.machine.type +- external: ecs + name: cloud.provider +- external: ecs + name: cloud.region +- external: ecs + name: ecs.version +- external: ecs + name: error +- external: ecs + name: error.message +- external: ecs + name: service.type +- external: ecs + name: host.architecture +- external: ecs + name: host.domain +- external: ecs + name: host.hostname +- external: ecs + name: host.id +- external: ecs + name: host.ip +- external: ecs + name: host.mac +- external: ecs + name: host.name +- external: ecs + name: host.os.family +- external: ecs + name: host.os.kernel +- external: ecs + name: host.os.name +- external: ecs + name: host.os.platform +- external: ecs + name: host.os.version +- external: ecs + name: host.type +- external: ecs + name: cloud.instance.name +- external: ecs + name: cloud.project.id +- external: ecs + name: container.id +- external: ecs + name: container.image.name +- external: ecs + name: container.labels +- external: ecs + name: container.name diff --git a/packages/aws/data_stream/apigateway_metrics/fields/fields.yml b/packages/aws/data_stream/apigateway_metrics/fields/fields.yml new file mode 100644 index 00000000000..680d3e6b685 --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/fields/fields.yml @@ -0,0 +1,103 @@ +- name: aws + type: group + fields: + - name: apigateway + type: group + fields: + - name: metrics + type: group + fields: + - name: 4XXError.sum + type: long + description: The number of client-side errors captured in a given period. + metric_type: counter + - name: 4xx.sum + type: long + description: The number of client-side errors captured in a given period. + metric_type: counter + - name: 5XXError.sum + type: long + description: The number of server-side errors captured in a given period. + metric_type: counter + - name: 5xx.sum + type: long + description: The number of server-side errors captured in a given period. + metric_type: counter + - name: Count.sum + type: long + description: The total number API requests in a given period. + metric_type: counter + - name: IntegrationLatency.avg + type: long + description: The time between when API Gateway relays a request to the backend and when it receives a response from the backend. + metric_type: gauge + unit: ms + - name: Latency.avg + type: long + description: The time between when API Gateway receives a request from a client and when it returns a response to the client. + metric_type: gauge + unit: ms + - name: DataProcessed.avg + type: long + description: The amount of data processed in bytes. + metric_type: gauge + unit: byte + - name: CacheHitCount.sum + type: long + description: The number of requests served from the API cache in a given period. + metric_type: counter + - name: CacheMissCount.sum + type: long + description: The number of requests served from the backend in a given period, when API caching is enabled. + metric_type: counter + - name: Count.sum + type: long + description: The total number of API requests in a given period. + metric_type: counter + - name: ConnectCount.sum + type: long + description: The number of messages sent to the connect route integration. + metric_type: counter + - name: MessageCount.sum + type: long + description: The number of messages sent to the WebSocket API, either from or to the client. + metric_type: counter + - name: IntegrationError.sum + type: long + description: The number of requests that return a 4XX/5XX response from the integration. + metric_type: counter + - name: ClientError.sum + type: long + description: The number of requests that have a 4XX response returned by API Gateway before the integration is invoked. + metric_type: counter + - name: ExecutionError.sum + type: long + description: Errors that occurred when calling the integration. + metric_type: counter + - name: dimensions + type: group + fields: + - name: ApiId + type: keyword + description: Each API created in API Gateway is assigned a unique ApiId, which is used to distinguish and reference that specific API within the system. + - name: Stage + type: keyword + description: It represents a specific version of the API that is accessible to clients. A stage allows you to manage different environments or versions of your API, such as development, testing, and production. + - name: Route + type: keyword + description: Routes define the path and HTTP methods that clients can use to access different functionalities of the API. + - name: ApiName + type: keyword + description: It represents a human-readable name that helps identify and differentiate the API within the API Gateway service. + - name: Method + type: keyword + description: It represents the HTTP method which defines the action that can be performed on a resource, such as retrieving, creating, updating, or deleting data. + - name: Resource + type: keyword + description: It represents an endpoint within the API that corresponds to a specific functionality, typically associated with a URL path segment. + - name: cloudwatch + type: group + fields: + - name: namespace + type: keyword + description: The namespace specified when query cloudwatch api. \ No newline at end of file diff --git a/packages/aws/data_stream/apigateway_metrics/fields/package-fields.yml b/packages/aws/data_stream/apigateway_metrics/fields/package-fields.yml new file mode 100644 index 00000000000..559d3ca3d71 --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/fields/package-fields.yml @@ -0,0 +1,15 @@ +- name: aws + type: group + fields: + - name: tags.* + type: object + description: | + Tag key-value pairs from AWS resources. + - name: s3.bucket.name + type: keyword + description: | + Name of a S3 bucket. + - name: dimensions.* + type: object + description: | + Metric dimensions. diff --git a/packages/aws/data_stream/apigateway_metrics/manifest.yml b/packages/aws/data_stream/apigateway_metrics/manifest.yml new file mode 100644 index 00000000000..88a042fa6c6 --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/manifest.yml @@ -0,0 +1,33 @@ +title: AWS API Gateway metrics +type: metrics +streams: + - input: aws/metrics + vars: + - name: period + type: text + title: Collection Period + multi: false + required: true + show_user: true + default: 5m + - name: data_granularity + type: text + title: Data Granularity + multi: false + required: false + show_user: false + - name: regions + type: text + title: Regions + multi: true + required: false + show_user: true + - name: latency + description: To address latency issues between certain AWS services and CloudWatch, specify a latency parameter to adjust the collection start time and end time in Metricbeat such as `5m`. + type: text + title: Latency + multi: false + required: false + show_user: false + title: AWS API Gateway metrics + description: Collect AWS API Gateway metrics diff --git a/packages/aws/data_stream/apigateway_metrics/sample_event.json b/packages/aws/data_stream/apigateway_metrics/sample_event.json new file mode 100644 index 00000000000..1c7ef75407b --- /dev/null +++ b/packages/aws/data_stream/apigateway_metrics/sample_event.json @@ -0,0 +1,89 @@ +{ + "agent": { + "name": "docker-fleet-agent", + "id": "fe8366bc-f3f8-4901-acce-b2c6788cf21f", + "type": "metricbeat", + "ephemeral_id": "dfa418e2-1fe7-4039-9e44-bec39fa60341", + "version": "8.6.2" + }, + "@timestamp": "2023-05-08T16:30:00.000Z", + "ecs": { + "version": "8.0.0" + }, + "data_stream": { + "namespace": "default", + "type": "metrics", + "dataset": "aws.apigateway_metrics" + }, + "service": { + "type": "aws" + }, + "host": { + "hostname": "docker-fleet-agent", + "os": { + "kernel": "5.15.90.1-microsoft-standard-WSL2", + "codename": "focal", + "name": "Ubuntu", + "family": "debian", + "type": "linux", + "version": "20.04.5 LTS (Focal Fossa)", + "platform": "ubuntu" + }, + "containerized": false, + "ip": [ + "172.18.0.7" + ], + "name": "docker-fleet-agent", + "id": "f91b175388d423fca58155815dfc2279", + "mac": [ + "02-42-AC-12-00-07" + ], + "architecture": "x86_64" + }, + "elastic_agent": { + "id": "fe8336bc-f3f1-4901-ac0a-b266788cf21f", + "version": "8.6.2", + "snapshot": false + }, + "metricset": { + "period": 300000, + "name": "cloudwatch" + }, + "event": { + "duration": 10830411419, + "agent_id_status": "verified", + "ingested": "2023-05-08T16:39:47Z", + "module": "aws", + "dataset": "aws.apigateway_metrics" + }, + "aws": { + "apigateway": { + "metrics": { + "4xx": { + "sum": 0 + }, + "5xx": { + "sum": 0 + }, + "DataProcessed": { + "avg": 48460 + }, + "Count": { + "sum": 2 + }, + "IntegrationLatency": { + "avg": 85.5 + }, + "Latency": { + "avg": 104 + } + } + }, + "cloudwatch": { + "namespace": "AWS/ApiGateway" + }, + "dimensions": { + "ApiId": "6am7mj7jqx" + } + } +} \ No newline at end of file diff --git a/packages/aws/docs/apigateway.md b/packages/aws/docs/apigateway.md new file mode 100644 index 00000000000..83db8e907d9 --- /dev/null +++ b/packages/aws/docs/apigateway.md @@ -0,0 +1,208 @@ +# AWS API Gateway + +The AWS API Gateway integration allows you to monitor [API Gateway](https://aws.amazon.com/api-gateway/) — a centralized API management service. + +Use the AWS API Gateway integration to collect metrics related to your HTTP, REST or WebSockets APIs. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference metrics when troubleshooting an issue. + +For example, you could use this integration to examine metrics related to error rates, response codes, and latency. You can pinpoint problematic areas, identify error-prone API endpoints, and troubleshoot performance issues. + +**IMPORTANT: Extra AWS charges on AWS API requests will be generated by this integration. Please refer to the AWS integration for more details.** + +## Data streams + +The API Gateway integration collects one type of data: metrics. + +**Metrics** give you insight into the state of API Gateway. +Metrics collected by the AWS API Gateway integration include the number of client and server errors, request and error counts and cache counts. + +See more details in the [Metrics reference](#metrics-reference). + +## Requirements + +You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. +You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your hardware. + +Before using any AWS integration you will need: + +* **AWS Credentials** to connect with your AWS account. +* **AWS Permissions** to make sure the user you're using to connect has permission to share the relevant data. + +For more details about these requirements, please take a look at the **AWS** integration documentation. + +## Setup + +Use this integration if you only need to collect data from the AWS API Gateway service. + +If you want to collect data from two or more AWS services, consider using the **AWS** integration. +When you configure the AWS integration, you can collect data from as many AWS services as you'd like. + +For step-by-step instructions on how to set up an integration, see the +[Getting started](https://www.elastic.co/guide/en/welcome-to-elastic/current/getting-started-observability.html) guide. + +## Metrics reference + +An example event for `apigateway` looks as following: + +```json +{ + "agent": { + "name": "docker-fleet-agent", + "id": "fe8366bc-f3f8-4901-acce-b2c6788cf21f", + "type": "metricbeat", + "ephemeral_id": "dfa418e2-1fe7-4039-9e44-bec39fa60341", + "version": "8.6.2" + }, + "@timestamp": "2023-05-08T16:30:00.000Z", + "ecs": { + "version": "8.0.0" + }, + "data_stream": { + "namespace": "default", + "type": "metrics", + "dataset": "aws.apigateway_metrics" + }, + "service": { + "type": "aws" + }, + "host": { + "hostname": "docker-fleet-agent", + "os": { + "kernel": "5.15.90.1-microsoft-standard-WSL2", + "codename": "focal", + "name": "Ubuntu", + "family": "debian", + "type": "linux", + "version": "20.04.5 LTS (Focal Fossa)", + "platform": "ubuntu" + }, + "containerized": false, + "ip": [ + "172.18.0.7" + ], + "name": "docker-fleet-agent", + "id": "f91b175388d423fca58155815dfc2279", + "mac": [ + "02-42-AC-12-00-07" + ], + "architecture": "x86_64" + }, + "elastic_agent": { + "id": "fe8336bc-f3f1-4901-ac0a-b266788cf21f", + "version": "8.6.2", + "snapshot": false + }, + "metricset": { + "period": 300000, + "name": "cloudwatch" + }, + "event": { + "duration": 10830411419, + "agent_id_status": "verified", + "ingested": "2023-05-08T16:39:47Z", + "module": "aws", + "dataset": "aws.apigateway_metrics" + }, + "aws": { + "apigateway": { + "metrics": { + "4xx": { + "sum": 0 + }, + "5xx": { + "sum": 0 + }, + "DataProcessed": { + "avg": 48460 + }, + "Count": { + "sum": 2 + }, + "IntegrationLatency": { + "avg": 85.5 + }, + "Latency": { + "avg": 104 + } + } + }, + "cloudwatch": { + "namespace": "AWS/ApiGateway" + }, + "dimensions": { + "ApiId": "6am7mj7jqx" + } + } +} +``` + +**Exported fields** + +| Field | Description | Type | Unit | Metric Type | +|---|---|---|---|---| +| @timestamp | Event timestamp. | date | | | +| aws.apigateway.metrics.4XXError.sum | The number of client-side errors captured in a given period. | long | | counter | +| aws.apigateway.metrics.4xx.sum | The number of client-side errors captured in a given period. | long | | counter | +| aws.apigateway.metrics.5XXError.sum | The number of server-side errors captured in a given period. | long | | counter | +| aws.apigateway.metrics.5xx.sum | The number of server-side errors captured in a given period. | long | | counter | +| aws.apigateway.metrics.CacheHitCount.sum | The number of requests served from the API cache in a given period. | long | | counter | +| aws.apigateway.metrics.CacheMissCount.sum | The number of requests served from the backend in a given period, when API caching is enabled. | long | | counter | +| aws.apigateway.metrics.ClientError.sum | The number of requests that have a 4XX response returned by API Gateway before the integration is invoked. | long | | counter | +| aws.apigateway.metrics.ConnectCount.sum | The number of messages sent to the connect route integration. | long | | counter | +| aws.apigateway.metrics.Count.sum | The total number of API requests in a given period. | long | | counter | +| aws.apigateway.metrics.DataProcessed.avg | The amount of data processed in bytes. | long | byte | gauge | +| aws.apigateway.metrics.ExecutionError.sum | Errors that occurred when calling the integration. | long | | counter | +| aws.apigateway.metrics.IntegrationError.sum | The number of requests that return a 4XX/5XX response from the integration. | long | | counter | +| aws.apigateway.metrics.IntegrationLatency.avg | The time between when API Gateway relays a request to the backend and when it receives a response from the backend. | long | ms | gauge | +| aws.apigateway.metrics.Latency.avg | The time between when API Gateway receives a request from a client and when it returns a response to the client. | long | ms | gauge | +| aws.apigateway.metrics.MessageCount.sum | The number of messages sent to the WebSocket API, either from or to the client. | long | | counter | +| aws.cloudwatch.namespace | The namespace specified when query cloudwatch api. | keyword | | | +| aws.dimensions.\* | Metric dimensions. | object | | | +| aws.dimensions.ApiId | Each API created in API Gateway is assigned a unique ApiId, which is used to distinguish and reference that specific API within the system. | keyword | | | +| aws.dimensions.ApiName | It represents a human-readable name that helps identify and differentiate the API within the API Gateway service. | keyword | | | +| aws.dimensions.Method | It represents the HTTP method which defines the action that can be performed on a resource, such as retrieving, creating, updating, or deleting data. | keyword | | | +| aws.dimensions.Resource | It represents an endpoint within the API that corresponds to a specific functionality, typically associated with a URL path segment. | keyword | | | +| aws.dimensions.Route | Routes define the path and HTTP methods that clients can use to access different functionalities of the API. | keyword | | | +| aws.dimensions.Stage | It represents a specific version of the API that is accessible to clients. A stage allows you to manage different environments or versions of your API, such as development, testing, and production. | keyword | | | +| aws.s3.bucket.name | Name of a S3 bucket. | keyword | | | +| aws.tags.\* | Tag key-value pairs from AWS resources. | object | | | +| cloud | Fields related to the cloud or infrastructure the events are coming from. | group | | | +| cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | +| cloud.account.name | The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. | keyword | | | +| cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | +| cloud.image.id | Image ID for the cloud instance. | keyword | | | +| cloud.instance.id | Instance ID of the host machine. | keyword | | | +| cloud.instance.name | Instance name of the host machine. | keyword | | | +| cloud.machine.type | Machine type of the host machine. | keyword | | | +| cloud.project.id | The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. | keyword | | | +| cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | +| cloud.region | Region in which this host, resource, or service is located. | keyword | | | +| container.id | Unique container id. | keyword | | | +| container.image.name | Name of the image the container was built on. | keyword | | | +| container.labels | Image labels. | object | | | +| container.name | Container name. | keyword | | | +| data_stream.dataset | Data stream dataset. | constant_keyword | | | +| data_stream.namespace | Data stream namespace. | constant_keyword | | | +| data_stream.type | Data stream type. | constant_keyword | | | +| ecs.version | ECS version this event conforms to. `ecs.version` is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword | | | +| error | These fields can represent errors of any kind. Use them for errors that happen while fetching events or in cases where the event itself contains an error. | group | | | +| error.message | Error message. | match_only_text | | | +| event.dataset | Event dataset | constant_keyword | | | +| event.module | Event module | constant_keyword | | | +| host.architecture | Operating system architecture. | keyword | | | +| host.containerized | If the host is a container. | boolean | | | +| host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. | keyword | | | +| host.hostname | Hostname of the host. It normally contains what the `hostname` command returns on the host machine. | keyword | | | +| host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of `beat.name`. | keyword | | | +| host.ip | Host ip addresses. | ip | | | +| host.mac | Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword | | | +| host.name | Name of the host. It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. | keyword | | | +| host.os.build | OS build information. | keyword | | | +| host.os.codename | OS codename, if any. | keyword | | | +| host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword | | | +| host.os.kernel | Operating system kernel version as a raw string. | keyword | | | +| host.os.name | Operating system name, without the version. | keyword | | | +| host.os.name.text | Multi-field of `host.os.name`. | match_only_text | | | +| host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword | | | +| host.os.version | Operating system version as a raw string. | keyword | | | +| host.type | Type of host. For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword | | | +| service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, `service.type` would be `elasticsearch`. | keyword | | | diff --git a/packages/aws/img/logo_apigateway.svg b/packages/aws/img/logo_apigateway.svg new file mode 100644 index 00000000000..970773333b5 --- /dev/null +++ b/packages/aws/img/logo_apigateway.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/aws/manifest.yml b/packages/aws/manifest.yml index dbca6a9b90f..76f3952b749 100644 --- a/packages/aws/manifest.yml +++ b/packages/aws/manifest.yml @@ -1,9 +1,9 @@ format_version: 1.0.0 name: aws title: AWS -version: 1.38.4 +version: 1.39.0 license: basic -description: Collect logs and metrics from Amazon Web Services with Elastic Agent. +description: Collect logs and metrics from Amazon Web Services (AWS) with Elastic Agent. type: integration categories: - aws @@ -739,5 +739,22 @@ policy_templates: title: Amazon GuardDuty logo size: 33x39 type: image/svg+xml + - name: apigateway + title: AWS API Gateway + description: Collect logs and metrics for AWS API Gateway with Elastic Agent. + data_streams: + - apigateway_metrics + categories: + - observability + inputs: + - type: aws/metrics + title: Collect API Gateway metrics + description: Collect API Gateway metrics using AWS CloudWatch. + input_group: metrics + icons: + - src: /img/logo_apigateway.svg + title: AWS API Gateway logo + size: 32x32 + type: image/svg+xml owner: github: elastic/obs-cloud-monitoring