Create a Custom Dashboard

  1. Download Custom_dashboard_script.zip.
    It contains:
    DirectoryDescription
    templatesContains json templates to create the dashboard files.
    dashboardDashboard json files are created here. It contains the sample json files.
    main.pyPython script to create the dashboards.
    readme.mdDescription of the solution.
  2. Run the following command:
    The preceding command prompts you to specify the dashboard type (application or tier) that you want to create.
    cd Custom_dashboard_script
    python3 main.py
  3. Based on your selected dashboard type, you will be prompted to specify the following dashboard details.
    Table 1. Application Level Dashboard Details
    VariableDescriptionDefaultPossible ValuesRequired
    Dashboard NameThe dashboard name to be displayed onDashboard & Reportsin the Controller UI.OpenAI_App_dashboardapp_dashboardOptional
    Application NameName of the Application with OpenAI backend calls.noneopenai_app_1Yes
    OpenAI Endpoints Host NameThe hostname of the OpenAI endpoint.api.openai.comapi.openai.comOptional
    OpenAI Endpoints PortThe port of the OpenAI endpoint.443443Optional
    Table 2. Tier Level Dashboard Details
    VariableDescriptionDefaultPossible ValuesRequired
    Dashboard NameThe dashboard name to be displayed onDashboard & Reportsin the Controller UI.tier_dashboardtier_dashboardOptional
    Application NameName of the Application with OpenAI backend calls.noneopenai_app_1Yes
    Tier NameName of the Tier exposed to OpenAI backend calls.noneopenai_tier_1Yes
    Business Transaction NameThe name of the business transaction reported to the host. This is to capture API Response time metric.noneopenai_btYes
    OpenAI Endpoints Host NameThe hostname of the OpenAI endpoint.api.openai.comapi.openai.comOptional
    OpenAI Endpoints PortThe port of the OpenAI endpoint.443443Optional
    Table 3. Application Level Moderation API Dashboard Details
    VariableDescriptionDefaultPossible ValuesRequired
    Dashboard NameThe dashboard name to be displayed onDashboard & Reportsin the Controller UI.OpenAI_Moderation_Appmoderation_app_dashboardOptional
    Application NameName of the Application with OpenAI backend calls.noneopenai_app_1Yes
    Table 4. Tier Level Moderation Dashboard Details
    VariableDescriptionDefaultPossible ValuesRequired
    Dashboard NameThe dashboard name to be displayed onDashboard & Reportsin the Controller UI.OpenAI_Moderation_Tiermoderation_tier_dashboardOptional
    Application NameName of the Application with OpenAI backend calls.noneopenai_app_1Yes
    Tier NameName of the Tier exposed to OpenAI backend calls.noneopenai_tier_1Yes
  4. Import the dashboard in the Controller UI.