Skip to content

Commit

Permalink
add logging details
Browse files Browse the repository at this point in the history
  • Loading branch information
alessiodionisi committed Dec 19, 2024
1 parent de8a887 commit 843b966
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/development/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,25 @@ The logs of all the tools used by furyctl, such as Terraform and Ansible, are in

---

### **Is there any best pratice in place for logging?**

<details>
<summary>Answer</summary>

- Log messages that the user sees by default should provide useful information and not leak implementation details, for example:

BAD:
INFO Running ansible playbooks

GOOD:
INFO Installing Kubernetes packages in the nodes

- All the tools that we call should be configured to output structured logs and should be wrapped in furyctl structured logs in the log file. This is handled automatically by the tools implementation on furyctl.

</details>

---

### **Are there any critical parts of the project that require special attention during future development?**

<details>
Expand Down

0 comments on commit 843b966

Please sign in to comment.