Gathering detailed insights and metrics for serverless-es-logs
Gathering detailed insights and metrics for serverless-es-logs
A Serverless plugin to transport logs to ElasticSearch
Installations
npm install serverless-es-logsDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>=10.0
Node Version
14.18.1
NPM Version
6.11.3
Releases
33
Languages
3
TypeScript
JavaScript
Shell
TypeScript (82.26%)
JavaScript (17.49%)
Shell (0.24%)
Developer
daniel-cottone
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
55 Stars
587 Commits
31 Forks
2 Watchers
16 Branches
14 Contributors
Updated on May 24, 2025
Maintainers
1
Package Meta Information
Latest Version
3.5.0
Package Id
serverless-es-logs@3.5.0
Unpacked Size
64.87 kB
Size
16.04 kB
File Count
25
NPM Version
6.11.3
Node Version
14.18.1
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
serverless-es-logs
A Serverless plugin for transporting Cloudwatch log groups within your CloudFormation stack into Elasticsearch.
Table of Contents
Installation
Install the plugin in your project:
1$ yarn add serverless-es-logs --dev 2$ npm install serverless-es-logs --save-dev
Add the plugin to your serverless.yml:
1plugins: 2 - serverless-es-logs
Usage
Define your configuration using the custom configuration option in serverless.yml:
1custom: 2 esLogs: 3 endpoint: some-elasticsearch-endpoint.us-east-1.es.amazonaws.com 4 index: some-index
Your logs will now be transported to the specified elasticsearch instance using the provided index.
Options
apiGWFilterPattern
(Optional) The filter pattern that the Cloudwatch subscription should use for your API Gateway access
logs. Default is [event], but you can override this to provide a pattern that will match your custom
access logs format. See
Cloudwatch filter pattern syntax
for more info.
1custom: 2 esLogs: 3 apiGWFilterPattern: '[request_timestamp, apigw_request_id, http_method, resource_path, request_status, response_latency]' 4 5provider: 6 logs: 7 restApi: 8 format: '$context.requestTimeEpoch $context.requestId $context.httpMethod $context.resourcePath $context.status $context.responseLatency'
endpoint
(Required) The endpoint of the Elasticsearch instance the logs should be transported to.
1custom: 2 esLogs: 3 endpoint: some-elasticsearch-endpoint.us-east-1.es.amazonaws.com
filterPattern
(Optional) The filter pattern that the Cloudwatch subscription should use for your lambda
functions. Default is [timestamp=*Z, request_id="*-*", event]. See
Cloudwatch filter pattern syntax
for more info.
1custom: 2 esLogs: 3 filterPattern: '[timestamp=*Z, request_id="*-*", event]'
includeApiGWLogs
(Optional) An option to capture access logs created by API Gateway and transport them to Elasticsearch.
1custom: 2 esLogs: 3 includeApiGWLogs: true 4 5provider: 6 name: aws 7 logs: 8 restApi: true
index
(Required) The Elasticsearch index that should be applied to the logs.
1custom: 2 esLogs: 3 index: some-index
indexDateSeparator
(Optional) The separator to use when creating the date suffix for the index. Default is ..
The format of the index will be: <index>-YYYY<indexDateSeparator>MM<indexDateSeparator>DD
1custom: 2 esLogs: 3 indexDateSeparator: '-'
This will result in a date like 2020-04-20.
retentionInDays
(Optional) The number of days that Cloudwatch logs should persist. Default is to never expire.
1custom: 2 esLogs: 3 retentionInDays: 7
tags
(Optional) Custom tags that should be applied to every log message processed by this plugin and sent to elasticsearch as fields.
1custom: 2 esLogs: 3 tags: 4 some_tag: something 5 some_other_tag: something_else
useDefaultRole
(Optional) Override role management for the log processer lambda and use the manually specified default role. Default is false.
1custom: 2 esLogs: 3 useDefaultRole: true 4 5provider: 6 name: aws 7 role: arn:aws:iam::123456789012:role/MyCustomRole
vpc
(Optional) VPC configuration for the log processor lambda to have.
1custom: 2 esLogs: 3 vpc: 4 securityGroupIds: 5 - sg-123456789 6 subnetIds: 7 - subnet-123456789 8 - subnet-223456789 9 - subnet-323456789
xrayTracingPermissions
(Optional) Adds AWS Xray writing permissions to the processor lambda. You will need these if you enable tracing for ApiGateway on your service.
1custom: 2 esLogs: 3 xrayTracingPermissions: true 4 5provider: 6 tracing: 7 apiGateway: true
reservedConcurrency
(Optional) Sets the reservedConcurrency of the lambda
1custom: 2 esLogs: 3 reservedConcurrency: 3 4 5provider: 6 tracing: 7 apiGateway: true
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 3/11 approved changesets -- score normalized to 2
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Warn: no topLevel permission defined: .github/workflows/status-check.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/daniel-cottone/serverless-es-logs/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/status-check.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/daniel-cottone/serverless-es-logs/status-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/status-check.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/daniel-cottone/serverless-es-logs/status-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/status-check.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/daniel-cottone/serverless-es-logs/status-check.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/status-check.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/daniel-cottone/serverless-es-logs/status-check.yml/master?enable=pin
- Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 23 are checked with a SAST tool
Reason
78 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
- Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
- Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-2mj8-pj3j-h362
- Warn: Project is vulnerable to: GHSA-gqf6-75v8-vr26
- Warn: Project is vulnerable to: GHSA-v45m-2wcp-gg98
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
- Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
- Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
- Warn: Project is vulnerable to: GHSA-m6cx-g6qm-p2cx
- Warn: Project is vulnerable to: GHSA-x8qc-rrcw-4r46
- Warn: Project is vulnerable to: GHSA-4328-8hgf-7wjr
- Warn: Project is vulnerable to: GHSA-93f3-23rq-pjfp
- Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv
- Warn: Project is vulnerable to: GHSA-pw54-mh39-w3hc
- Warn: Project is vulnerable to: GHSA-xgh6-85xh-479p
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
- Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
- Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
- Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
3
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More