Skip to content

[Database metrics] Add start of README #36

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 2 commits into from
Nov 17, 2020
Merged

[Database metrics] Add start of README #36

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9294789
add readme
chinandrew Nov 16, 2020
4ecf1fa
Update readme wording
chinandrew Nov 16, 2020
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
17 changes: 17 additions & 0 deletions src/database_metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Capturing Database Metrics
This module contains methods for collecting metrics on the database server under different conditions.

## Usage
1. Using the [Docker tutorials](https://github.com/cmu-delphi/delphi-epidata/blob/main/docs/epidata_development.md),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the backend guide might be more direct than the epidata guide (since the latter points to the former), but up to you

link to backend guide: https://github.com/cmu-delphi/operations/blob/main/docs/backend_development.md

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(nevermind, i see you use the web and database images below -- pls disregard)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 btw, those guides were super useful.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks :D glad to hear that

install Docker and clone all the relevant repositories to a working directory. Do not build the images yet.
2. Obtain the test data you will be running. Place it into a `common_full/`folder in the same working directory, with
sub folders corresponding to the production ingestion structure: `common_full/covidcast/receiving/<data_source>/filename`
3. Before building the images, you will need to make two edits:
a. Edit `repos/delphi/operations/src/secrets.py` by setting `db.host = 'delphi_database_epidata'` and
`set db.epi = ('user', 'pass')`, which will match the testing docker image.
b. Add `COPY common_full common_full` to `repos/delphi/operations/dev/docker/python/Dockerfile` after copying source files.
4. Continue with the tutorial to complete the following steps:
a. Build the `delphi_web`, `delphi_web_epidata`, `delphi_database`, and `delphi_python` images.
b. Create the `delphi-net` network.
c. Run the database and web server.
5. TODO #35. TBD based on exact user-facing implementation