Edit

Share via


GraphQL monitoring dashboard and logging (preview)

Important

This feature is in preview.

Gain complete visibility into your production GraphQL APIs with Microsoft Fabric's integrated monitoring and logging capabilities. Track real-time performance metrics, analyze query patterns, troubleshoot errors, and understand how clients interact with your APIs—all from within the Fabric workspace.

Key monitoring capabilities:

  • Real-time dashboard: Visualize API performance, response times, and error rates with interactive charts
  • Detailed request logging: Capture complete request/response data, query complexity, and execution details
  • Performance analytics: Identify slow queries, optimize bottlenecks, and track usage trends over time
  • Error tracking: Monitor failures, investigate root causes, and improve API reliability

This easy-to-understand monitoring dashboard empowers you to make data-driven decisions about your API performance and usage patterns. Whether you're troubleshooting issues, optimizing application performance, or ensuring a smooth user experience, the monitoring tools provide invaluable insights. You can quickly identify and address problems while gaining a deeper understanding of how your APIs are being utilized.

Note

The monitoring feature incurs extra charges against your capacity.

Who uses monitoring and logging

GraphQL monitoring and logging are essential for:

  • Fabric workspace admins monitoring API health, performance, and capacity consumption in real-time
  • Fabric capacity administrators tracking usage patterns and optimizing capacity allocation for GraphQL workloads
  • Data governance teams auditing data access, detecting anomalies, and ensuring compliance with data policies
  • Data engineers analyzing query patterns and optimizing Fabric lakehouse and warehouse access
  • Platform teams understanding Fabric API adoption and making data-driven decisions about API investments

Use monitoring and logging when you need visibility into production GraphQL API behavior, performance metrics, and usage analytics.

Prerequisites

  • You need to enable workspace monitoring and add an eventhouse for monitoring. For more information about how to enable it, see Workspace Monitoring Overview. Workspace monitoring is disabled by default.

    Note

    If you just enabled workspace monitoring, you might need to refresh the page before proceeding with GraphQL monitoring setup.

  • You must have a deployed API for GraphQL in Fabric. For more information about how to deploy, see Create an API for GraphQL in Fabric and add data.

Enabling GraphQL API monitoring

Now that you have workspace monitoring enabled per the prerequisites, you need to separately enable monitoring for your specific GraphQL API. GraphQL monitoring is turned off by default and must be enabled for each API individually. Here's how to enable it:

  1. To enable the metrics and/or logging experience for each API for GraphQL in your tenant, open your GraphQL API and then select the Settings icon:

    Screenshot of selecting API for GraphQL settings.

  2. From the API settings window, select the Monitoring (preview) page from the left menu. If workspace monitoring isn't already enabled, you see a note guiding you to go to the workspace settings to enable it.

  3. After you enable monitoring for the workspace, you see the options to enable Metrics (View aggregated API activity in a dashboard), Logging (View logs with detailed information for each API request), or both.

    Screenshot of Metrics and Logging Toggles from the Monitoring setting of API for GraphQL.

    Note

    The metrics and logs are saved to separate tables in the same Kusto database, and you can enable each feature separately depending on your requirement.

  4. Enable the desired options by toggling the switches one at a time to the On position.

Note

Metrics and logging incur extra costs. Access API requests details from API request activity page.

API request activity

Once monitoring is enabled, select the API request activity button from the top ribbon to access monitoring details.

Screenshot of API request activity tab from the top ribbon.

In the API request activity page, you can select one of the following tabs to view specific monitoring data:

  1. API dashboard (for Metrics): This page displays all counters and charts for the specified time range.
  2. API requests (for Logging): This page lists API requests within the specified time range.

In the following sections, we describe the functionality of each option.

Metrics (API dashboard)

The API dashboard provides a comprehensive overview of your GraphQL API performance through interactive charts and metrics. To access the dashboard, select the API dashboard tab from the API request activity page.

The dashboard displays key performance indicators across customizable time ranges, with all data retained for 30 days. Hover over any chart to see detailed information for specific data points.

Screenshot of API dashboard.

Health indicators

  • API Health Status: Visual indicator showing overall API health based on success rate

    • Green: 75-100% successful requests (Healthy)

    • Yellow: 50-74% successful requests (Needs Attention)

    • Red: Below 50% successful requests (Unhealthy)

      Screenshot of API dashboard showing the health index.

  • Success Rate: Percentage of successful requests versus total requests in the selected time range

    Screenshot of API dashboard showing the success rate.

Volume metrics

  • API Requests per Second: Real-time view of request volume over time

    Screenshot of API dashboard showing the number of API requests per second.

  • Total API Requests: Aggregate count of all requests in the selected time range

    Screenshot of API dashboard showing the number of API requests.

  • Request Status Bar Chart: Visual breakdown showing successful requests versus errors over time

    Screenshot of API dashboard showing number requests bar chart.

Performance metrics

  • Latency Line Chart: Response time trends showing performance over time

    Screenshot of API dashboard showing the latency line chart.

Customization options

  • Time Range Selection: Choose from different time windows (hour, day, week, month) to analyze your data. Data retention is limited to 30 days.

    Screenshot of API dashboard showing the time range option.

From overview to details

The API dashboard page provides an excellent high-level view of your API's health and performance trends. When you spot issues like declining success rates, increased latency, or unusual request patterns, the API requests page in the next section gives you the detailed logs needed for investigation.

While the dashboard shows you what is happening with your API, the logging page shows you exactly which requests are causing problems, complete with error messages, response details, and execution times for individual queries.

Logging (API requests)

The API requests page captures comprehensive details about every GraphQL operation, enabling deep investigation and troubleshooting. Access this detailed view by selecting the API requests tab from the API request activity page.

This request-level logging complements the dashboard's overview metrics by providing the granular data needed to diagnose specific issues, optimize slow queries, and understand client behavior patterns.

Screenshot of API request page showing the list of requests.

Request information

Each logged request includes:

  • Request ID: Unique identifier for tracking specific operations
  • Operation Type: Query or Mutation classification
  • Transport Protocol: HTTP method used for the request
  • Timestamp: Exact time when the request was received
  • Duration: Complete execution time from request to response
  • Response Size: Data payload size returned to the client
  • Status: Success or failure indicator with detailed error information

Data exploration tools

  • Time Range Filtering: Select from hour, day, week, or month views (30-day retention limit)

    Screenshot of API request page showing time range for the list of requests.

  • Advanced Sorting: Sort by timestamp or duration in ascending/descending order

  • Search and Filtering: Find specific requests using text search across all request details

  • Column Management: Resize and reorder columns to customize the table view

  • Detailed Inspection: Click any request to view complete request/response data, including error messages and warnings

Troubleshooting workflows

Use the logging page to:

  • Identify failing queries: Filter by status to find errors and investigate root causes
  • Analyze performance bottlenecks: Sort by duration to find the slowest-executing operations
  • Track usage patterns: Review operation types and timing to understand client behavior
  • Debug specific issues: Search for particular error messages or request IDs reported by users