Getting started with APM

APM collects metrics on your app’s performance at four levels of granularity: services, resources, traces, and spans level.

Services

A service is a set of processes that do the same job. For instance, a simple web application may consist of two services:

• A single webapp service and a single database service.

While a more complex environment may break it out into 6 services:

• 3 separate services: webapp, admin, and query.
• 3 separate external service: master-db, replica-db, and yelp-api.

APM automatically assigns names to your services; however you can also name them explicitly. See instructions for: Go, Java, Python, Ruby.

Service names:

• Must be lowercase, alphanumeric characters.
• Cannot have more than 50 characters.
• Cannot contain spaces (spaces are replaced with underscores).
• must adhere to metric naming rules.

Note: Services must have a type attached, APM automatically assigns services one of four types: web, database, cache, custom.

You can also alert on any service level metric. Read more about monitoring services in APM on the service list and service dashboard pages.

Resources

A Resource is a particular action for a service.

• For a web application: some examples might be a canonical URL, such as /user/home or a handler function like web.user.home (often referred to as “routes” in MVC frameworks).
• For a SQL database: a resource is the query itself, such as SELECT * FROM users WHERE id = ?.

Resources should be grouped together under a canonical name, like /user/home rather than have /user/home?id=100 and /user/home?id=200 as separate resources. APM automatically assigns names to your resources; however you can also name them explicitly. See instructions for: Go, Java, Python, Ruby.

These resources can be found after clicking on a particular service.

Resource names:

• Must be lowercase, alphanumeric characters
• Cannot exceed 5000 bytes

Alert on any resource level metric. Read more about monitoring resources in APM on the resource dashboard page.

Trace

A trace is used to track the time spent by an application processing a single operation, each trace consists of one or more spans.

For example, a trace can be used to track the entire time spent processing a complicated web request. Even though the request may require multiple resources and machines to handle the request, all of these function calls and sub-requests would be encapsulated within a single trace.

Spans

A span represents a logical unit of work in the system.

Spans are associated with a service and optionally a resource. Each span consists of a start time, a duration, and optional tags. For example, a span can describe the time spent on a distributed call on a separate machine, or the time spent in a small component within a larger operation. Spans can be nested within each other, and in those instances will have a parent-child relationship.

Further Reading