Skip to content

Commit

Permalink
added best practices section in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dvarelas committed Aug 13, 2023
1 parent 9fe7b78 commit 9e8a5ee
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/docs/best-practices.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Best practices
sidebar_position: 5
---

## Best practices

Here are three best practices to follow when using Cortisol:

1. Cortisol uses the volume of the logged data from the run to project and approximate
its value over a month using linear extrapolation. To obtain a precise estimation,
it's essential to set the `--run-time` to an adequate duration.
The `--spawn-rate` influences `--run-time`,
as a higher rate of user spawning results in a shorter `--run-time`.

2. Create scenarios that accurately replicate the user actions or API calls
that generate log entries. If certain actions trigger specific log types or levels,
ensure your cortisolfile defines those actions accordingly.
The goal is to generate log entries in a way that mirrors real-world usage.

3. Gradually vary the intensity of the load during testing to observe how the volume of logs changes.
Start with a lower load and increase it step by step. This will help you identify thresholds
where log volume might start to spike significantly or where certain log types become more frequent.

0 comments on commit 9e8a5ee

Please sign in to comment.