REST API resources

Tip

Current level is v1.

Metric resource

The metrics namespace provide entry points for reading and creating metrics entries. Despite a metric is associated with both an execution context and a session, the monitor-server does not require prior knowledge of these element at the moment you POST your metric. This has been done willingly in order to avoid contention and workflow entanglement.

The following API entry points are available in the metric namespace:

• Create a metric
• List metrics
• Counting metrics

Filters resource

This namespace provides special entry points for retrieving metrics from conditions that might involve test sessions. Retrieving all metrics matching a given SCM reference is a good example.

The following API entry points are available for this namespace:

• Listing metrics given a SCM reference
• Counting metrics by SCM reference
• Counting metrics linked to a SCM reference
• Listing sessions associated to a SCM reference
• Listing metrics of a given scope (function, module …)
• Counting metrics of a specific test entity (function, module …)

Items resource

The items namespace provides the necessary entry points for accessing metrics given a test name. The following API entry points are available:

• List metrics by test pattern
• List metrics by test
• Count all metrics for a given test

Variants resource

The variants namespace works like the items one, but focus on variant tests, i.e. your fully qualified test name. The following API entry points are available:

• List metrics for a specific variant
• List metrics by test pattern
• Count all metrics for a given test

Session resource

The session namespace provide entry points for creating, reading and querying information by sessions. Sessions can be seen as a single pytest run. The following API entry points are available in the session namespace:

• Create a session
• List all sessions
• Count sessions
• List metrics of a session
• Count metrics of a session
• Get session details

Execution contexts resource

The context namespace provide entry points for creating, reading and querying information by contexts. Execution Contexts (referred to as contexts in the monitor-server-api) are information about the system which operated tests. The following API entry points are available in the contexts namespace:

• Create a context
• List contexts
• Count contexts
• List metrics of a context
• Count metrics of a context
• Get context details

Components resource

Components aims is to help you categorize tests. This can be by entity (a library for instance), a specific part in your core system or anything else. They are useful to restrict your queries. The following API entry points are available in the components namespace:

• List components
• Counting components
• Listing metrics of a component
• List pipelines associated to a component
• List available builds of a pipeline associated to a component
• List sessions of a build associated to a component
• Listing a component’s item metrics
• Listing a component’s variant metrics

Pipelines and build resource

Pipelines have been introduced to help comparing results between two changes from a CI point of view. They are automatically set by pytest-monitor on the following Software Factories:

• Jenkins

• GitlabCI

• DroneCI

• TravisCI

• CircleCI

The following API entry points are available in the pipelines namespace:

• List pipelines
• List builds of a pipeline
• List all build sessions

Resource Usages resource

This namespace is all about collecting tests which consumes most (resp. less) a given resource. You can filter by sub-resource like components or pipelines.

To retrieve these metrics, consider the following entry points:

• List metrics with highest/lowest resource usage
• List all metrics with highest/lowest resource usage on a specific component
• List all metrics with highest/lowest resource usage on a specific pipeline
• List all metrics with highest/lowest resource usage on a specific build