| get_scout_setup_instructions | Get step-by-step instructions to instrument Scout APM in a framework. Always use this tool first when asked to setup/instrument/configure
Scout APM in an application. This provides official, tested configuration
instructions that should be followed exactly.
Supported frameworks:
- Web: bottle, dash, django, falcon, fastapi, flask, hug, rails, starlette
- Background Jobs: celery, dramatiq, huey, rq
- Database: sqlalchemy
Args:
framework: The framework or library name (e.g., "fastapi", "django", "celery")
Returns:
Complete setup instructions including installation, configuration, and examples.
|
| list_apps | List available Scout APM applications. Provide an optional `active_since` ISO 8601
to filter to only apps that have reported data since that time. Defaults to the
metric retention period of thirty days.
Args:
active_since (str): ISO 8601 datetime string to filter apps active since that
time.
|
| get_app_metrics | Get individual metric data for a specific application. Args:
app_id (int): The ID of the Scout APM application.
metric (str): The metric to retrieve (e.g., "response_time", "throughput").
from_ (str): The start datetime in ISO 8601 format.
to (str): The end datetime in ISO 8601 format.
|
| get_app_endpoints | Get all endpoints for a specific application. Also gets aggregated performance
metrics withing the window of "from_" to "to". Useful for identifying high
throughput, high latency or high error rate endpoints accross the application with a
single call.
These endpoints can be used in other tools to fetch endpoint-specific metrics,
traces or errors.
Args:
app_id (int): The ID of the Scout APM application.
from_ (str): The start datetime in ISO 8601 format.
to (str): The end datetime in ISO 8601 format.
|
| get_endpoint_metrics | Get a single timeseries metric for a specific endpoint in an application.
Args:
app_id (int): The ID of the Scout APM application.
endpoint (str): The endpoint path (e.g., "/users", "/orders").
metric (str): The metric to retrieve (e.g., "response_time", "throughput").
from_ (str): The start datetime in ISO 8601 format.
to (str): The end datetime in ISO 8601 format.
|
| get_app_endpoint_traces | Get recent traces for an app filtered to a specific endpoint.
Args:
app_id (int): The ID of the Scout APM application.
endpoint_id (str): The ID of the endpoint to filter traces.
from_ (str): The start datetime in ISO 8601 format.
to (str): The end datetime in ISO 8601 format.
|
| get_app_trace | Get an individual trace with all spans.
Args:
app_id (int): The ID of the Scout APM application.
trace_id (int): The ID of the trace to retrieve.
|
| get_app_error_groups | Get recent error_groups for an app, optionally filtered to a specific endpoint or
group.
Args:
app_id (int): The ID of the Scout APM application.
endpoint_id (str | None): The ID of the endpoint to filter errors. If None,
fetches all errors for the app.
error_group_id (str | None): The ID of the error group to filter errors.
|
| get_app_insights | Get or generate all insights for an application (cached for 5 minutes).
Returns performance insights including N+1 queries, memory bloat, and slow queries.
Each insight type includes count, new_count, and items array with specific details.
If insight_type is provided, only that type will be returned.
Args:
app_id (int): The ID of the Scout APM application.
insight_type: (str | None): Type of insight to filter (n_plus_one, memory_bloat,
slow_query) If None (the default), all types will
be returned.
limit (int | None): Maximum number of items per insight type (default: 20).
|
