diff --git a/docs/my-website/docs/proxy/team_logging.md b/docs/my-website/docs/proxy/team_logging.md index c3ceec3dce3..bb35839bb25 100644 --- a/docs/my-website/docs/proxy/team_logging.md +++ b/docs/my-website/docs/proxy/team_logging.md @@ -22,7 +22,7 @@ Team 3 -> Disabled Logging (for GDPR compliance) - `arize` -## [BETA] Team Logging via API +## [BETA] Team Logging :::info @@ -30,7 +30,54 @@ Team 3 -> Disabled Logging (for GDPR compliance) ::: +### UI Usage +1. Create a Team with Logging Settings + +Create a team called "AI Agents" + + +
+ + +2. Create a Key for the Team + +We will create a key for the team "AI Agents". The team logging settings will be used for all keys created for the team. + + + +
+ + +3. Make a test LLM API Request + +Use the new key to make a test LLM API Request, we expect to see the logs on your logging provider configured in step 1. + + + +
+ +4. Check Logs on your Logging Provider + +Navigate to your configured logging provider and check if you received the logs from step 2. + + + +
+ +### API Usage ### Set Callbacks Per Team #### 1. Set callback for team @@ -205,11 +252,51 @@ Use the `/key/generate` or `/key/update` endpoints to add logging callbacks to a ::: -### How key based logging works: +**How key based logging works:** - If **Key has no callbacks** configured, it will use the default callbacks specified in the config.yaml file - If **Key has callbacks** configured, it will use the callbacks specified in the key + +### UI Usage + +1. Create a Key with Logging Settings + +When creating a key, you can configure the specific logging settings for the key. These logging settings will be used for all requests made with this key. + + +
+ + +2. Make a test LLM API Request + +Use the new key to make a test LLM API Request, we expect to see the logs on your logging provider configured in step 1. + + + +
+ +3. Check Logs on your Logging Provider + +Navigate to your configured logging provider and check if you received the logs from step 2. + + + +
+ +### API Usage + + + diff --git a/docs/my-website/img/team_logging1.png b/docs/my-website/img/team_logging1.png new file mode 100644 index 00000000000..be00048fb69 Binary files /dev/null and b/docs/my-website/img/team_logging1.png differ diff --git a/docs/my-website/img/team_logging2.png b/docs/my-website/img/team_logging2.png new file mode 100644 index 00000000000..f690a5b8022 Binary files /dev/null and b/docs/my-website/img/team_logging2.png differ diff --git a/docs/my-website/img/team_logging3.png b/docs/my-website/img/team_logging3.png new file mode 100644 index 00000000000..02c31d9c8d5 Binary files /dev/null and b/docs/my-website/img/team_logging3.png differ diff --git a/docs/my-website/img/team_logging4.png b/docs/my-website/img/team_logging4.png new file mode 100644 index 00000000000..e2c6feb0124 Binary files /dev/null and b/docs/my-website/img/team_logging4.png differ