Skip to content

Commit

Permalink
[TailAware] Adds developing notes
Browse files Browse the repository at this point in the history
  • Loading branch information
eiathom committed Jan 31, 2024
1 parent 011d5ff commit e9d4459
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
venv

1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.10.0
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,29 @@ For this example we are focusing attention on tail (a.k.a tail-aware) sampling.

Head sampling should be transparently applied 'higher' up the signal networking
chain: close to the application / instrumentation.

## Developing

```bash
# install pyenv
curl https://pyenv.run | bash

# set the local python version in use
pyenv local $(head -1 .python-version)

# create a virtual environment
python -m venv venv

# activate the environment
source venv/bin/activate

# install dependencies
pip install -r requirements/development.txt

# run checks on the template for proper syntax
cfn-lint --template template.yaml --region us-east-1 --ignore-checks W

# close the environment when done
deactivate

```
2 changes: 2 additions & 0 deletions requirements/development.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
cfn-lint

0 comments on commit e9d4459

Please sign in to comment.