Skip to content
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.

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

Document logging options for Bots #2719

Open
reshmakh opened this issue Aug 24, 2023 · 1 comment
Open

Document logging options for Bots #2719

reshmakh opened this issue Aug 24, 2023 · 1 comment
Assignees
Labels
bots Features and fixes related to bots and automation documentation Improvements or additions to documentation

Comments

@reshmakh
Copy link
Member

reshmakh commented Aug 24, 2023

#2528 introduced the ability to configure bot logging to fit high volume use cases.

The documentation needs to be updated accordingly

Proposed changes in this document: https://www.medplum.com/docs/bots/bots-in-production

  1. Add a section Configuring Bot Logging
  2. Note that when there are thousands of bot invocations per day you may want to tune the log level of bots. Given an example of the kind of situations that may generate high-volume bots (e.g. ADT feeds, high-frequency device messages, etc.)
  3. There are two levers for controlling bot log levels (see this PR) a. What type of events are logged (error, success etc) known as auditEventTrigger (see here)
    b. Where the events are logged
    i. Option 1. To DB so you can see it in the app.
    Best practice is to always do this to start, for debugging / testing
    ii. Option 2. To log only, not visible in Medplum app but logged - better for high volume
@reshmakh reshmakh added the bots Features and fixes related to bots and automation label Aug 24, 2023
@reshmakh reshmakh added this to the August 31, 2023 milestone Aug 24, 2023
@reshmakh reshmakh added the documentation Improvements or additions to documentation label Aug 24, 2023
@ksmith94
Copy link
Collaborator

I'll work on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bots Features and fixes related to bots and automation documentation Improvements or additions to documentation
Projects
Status: No status
Development

No branches or pull requests

2 participants