Skip to content

Create minimal readme linking to main docs #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 12, 2024
Merged

Create minimal readme linking to main docs #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
# Axiom CloudFront Lambda [![CI](https://github.com/axiomhq/axiom-cloudfront-lambda/actions/workflows/ci.yaml/badge.svg)](https://github.com/axiomhq/axiom-cloudfront-lambda/actions/workflows/ci.yaml)

Easy to use AWS CloudFormation template to deploy a Bucket and a Lambda to send
logs from your CloudFront to [Axiom](https://axiom.co).
Use the Axiom CloudFront Lambda to send CloudFront logs to [Axiom](https://axiom.co) using AWS S3 bucket and Lambda. After you set this up, you can observe your static and dynamic content and run deep queries on your CloudFront distribution logs efficiently and properly.

## Guide
## Documentation

1. Create an account at [Axiom Cloud](https://cloud.axiom.co)
2. Create a dataset and an API token with ingest permission for that dataset
3. If S3 bucket exists, [![Launch Stack](https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png)](https://console.aws.amazon.com/cloudformation/home?#/stacks/new?stackName=CloudFront-Axiom&templateURL=https://axiom-cloudformation-stacks.s3.amazonaws.com/axiom-cloudfront-lambda-base-cloudformation-stack.yaml)
4. If S3 bucket doesn't exists, Launch the stack: [![Launch Stack](https://s3.amazonaws.com/cloudformation-examples/cloudformation-launch-stack.png)](https://console.aws.amazon.com/cloudformation/home?#/stacks/new?stackName=CloudFront-Axiom&templateURL=https://axiom-cloudformation-stacks.s3.amazonaws.com/axiom-cloudfront-lambda-cloudformation-stack.yaml)
5. Set up your CloudFront to store logs in the bucket you specified
For more information on how to set up and use the Axiom CloudFront Lambda, see the [Axiom documentation](https://axiom.co/docs/send-data/cloudfront).
Loading