Create a Custom Dashboard

  1. Download Custom_dashboard_script.zip.
    It contains:
    Directory Description
    templates Contains json templates to create the dashboard files.
    dashboard Dashboard json files are created here. It contains the sample json files.
    main.py Python script to create the dashboards.
    readme.md Description of the solution.
  2. Run the following command: 
    cd Custom_dashboard_script
python3 main.py
    The preceding command prompts you to specify the dashboard type (application or tier) that you want to create.
  3. Based on your selected dashboard type, you will be prompted to specify the following dashboard details.
    Table 1. Application Level Dashboard Details
    Variable Description Default Possible Values Required
    Dashboard Name The dashboard name to be displayed on Dashboard & Reports in the Controller UI. OpenAI_App_dashboard app_dashboard Optional
    Application Name Name of the Application with OpenAI backend calls. none openai_app_1 Yes
    OpenAI Endpoints Host Name The hostname of the OpenAI endpoint. api.openai.com api.openai.com Optional
    OpenAI Endpoints Port The port of the OpenAI endpoint. 443 443 Optional
    Table 2. Tier Level Dashboard Details
    Variable Description Default Possible Values Required
    Dashboard Name The dashboard name to be displayed on Dashboard & Reports in the Controller UI. tier_dashboard tier_dashboard Optional
    Application Name Name of the Application with OpenAI backend calls. none openai_app_1 Yes
    Tier Name Name of the Tier exposed to OpenAI backend calls. none openai_tier_1 Yes
    Business Transaction Name The name of the business transaction reported to the host. This is to capture API Response time metric. none openai_bt Yes
    OpenAI Endpoints Host Name The hostname of the OpenAI endpoint. api.openai.com api.openai.com Optional
    OpenAI Endpoints Port The port of the OpenAI endpoint. 443 443 Optional
    Table 3. Application Level Moderation API Dashboard Details
    Variable Description Default Possible Values Required
    Dashboard Name The dashboard name to be displayed on Dashboard & Reports in the Controller UI. OpenAI_Moderation_App moderation_app_dashboard Optional
    Application Name Name of the Application with OpenAI backend calls. none openai_app_1 Yes
    Table 4. Tier Level Moderation API Dashboard Details
    Variable Description Default Possible Values Required
    Dashboard Name The dashboard name to be displayed on Dashboard & Reports in the Controller UI. OpenAI_Moderation_Tier moderation_tier_dashboard Optional
    Application Name Name of the Application with OpenAI backend calls. none openai_app_1 Yes
    Tier Name Name of the Tier exposed to OpenAI backend calls. none openai_tier_1 Yes
  4. Import the dashboard in the Controller UI.
    See Create and Manage Custom Dashboards and Templates.

Example Dashboard

Note: Navigate to Tiers & Nodes > My Dashboards and create a dashboard for the selected application by copying and pasting widgets from the existing dashboard for easier navigation.