elastic / elastic-serverless-forwarder

Elastic Serverless Forwarder
Other
35 stars 34 forks source link

updated docs #588

Closed aspacca closed 7 months ago

aspacca commented 8 months ago

Docs

What does this PR do?

Fixes https://github.com/elastic/elastic-serverless-forwarder/issues/488 Fixes https://github.com/elastic/elastic-serverless-forwarder/issues/521 Fixes https://github.com/elastic/elastic-serverless-forwarder/issues/522

Why is it important?

Better documentation improves UX

Checklist

~- [ ] My code follows the style guidelines of this project~ ~- [ ] I have commented my code, particularly in hard-to-understand areas~

Author's Checklist

How to test this PR locally

Related issues

-

Use cases

Screenshots

Logs

github-actions[bot] commented 8 months ago

File Coverage Lines Branches Missing
All files 100% 100% 100% :white_check_mark:
main_aws.py 100% 100% 100% :white_check_mark:
handlers/__init__.py 100% 100% 100% :white_check_mark:
handlers/aws/__init__.py 100% 100% 100% :white_check_mark:
handlers/aws/cloudwatch_logs_trigger.py 100% 100% 100% :white_check_mark:
handlers/aws/exceptions.py 100% 100% 100% :white_check_mark:
handlers/aws/handler.py 100% 100% 100% :white_check_mark:
handlers/aws/kinesis_trigger.py 100% 100% 100% :white_check_mark:
handlers/aws/replay_trigger.py 100% 100% 100% :white_check_mark:
handlers/aws/s3_sqs_trigger.py 100% 100% 100% :white_check_mark:
handlers/aws/sqs_trigger.py 100% 100% 100% :white_check_mark:
handlers/aws/utils.py 100% 100% 100% :white_check_mark:
share/__init__.py 100% 100% 100% :white_check_mark:
share/config.py 100% 100% 100% :white_check_mark:
share/environment.py 100% 100% 100% :white_check_mark:
share/events.py 100% 100% 100% :white_check_mark:
share/expand_event_list_from_field.py 100% 100% 100% :white_check_mark:
share/factory.py 100% 100% 100% :white_check_mark:
share/include_exlude.py 100% 100% 100% :white_check_mark:
share/json.py 100% 100% 100% :white_check_mark:
share/logger.py 100% 100% 100% :white_check_mark:
share/multiline.py 100% 100% 100% :white_check_mark:
share/secretsmanager.py 100% 100% 100% :white_check_mark:
share/utils.py 100% 100% 100% :white_check_mark:
share/version.py 100% 100% 100% :white_check_mark:
shippers/__init__.py 100% 100% 100% :white_check_mark:
shippers/composite.py 100% 100% 100% :white_check_mark:
shippers/es.py 100% 100% 100% :white_check_mark:
shippers/factory.py 100% 100% 100% :white_check_mark:
shippers/logstash.py 100% 100% 100% :white_check_mark:
shippers/shipper.py 100% 100% 100% :white_check_mark:
storage/__init__.py 100% 100% 100% :white_check_mark:
storage/decorator.py 100% 100% 100% :white_check_mark:
storage/factory.py 100% 100% 100% :white_check_mark:
storage/payload.py 100% 100% 100% :white_check_mark:
storage/s3.py 100% 100% 100% :white_check_mark:
storage/storage.py 100% 100% 100% :white_check_mark:

Minimum allowed coverage is 100%

Generated by :monkey: cobertura-action against 5d48bedd6aa2168e72fe4e70aea9af817eae7b69