Do more with your data
Build curated dashboards, advanced visualizations, and custom alerts.
Ways to build on New Relic
NRQL
The New Relic Query Language (NRQL) is a powerful, SQL-like query syntax in New Relic Insights that lets you access your data, including custom events and attributes you’ve added.
Here are a few example NRQL queries to get you started.
--Discover what web transactions have the most errors across all your applications
SELECT count(*) FROM TransactionError FACET transactionName
--Graph the last day of page views that took over 2 seconds to complete broken down by the client's browser
SELECT count(*) FROM PageView WHERE duration > 2 SINCE 1 day ago FACET userAgentName TIMESERIES AUTO
--Show me the top 100 processes by CPU utilizations across all of my hosts for the last hour
SELECT average(cpuPercent) FROM ProcessSample FACET processDisplayName LIMIT 100 SINCE 60 minutes ago
REST APIs
Extract data and manage your monitoring with RESTful APIs.
Here's an example command to fetch a list of all recent deployments for a given application.
curl -X GET 'https://api.newrelic.com/v2/applications/YOUR_APPLICATION_ID/deployments.json' \
-H 'X-Api-Key:YOUR_API_KEY' -i
An example response JSON for deployments.
{
"deployments": [
{
"id": 106368177,
"revision": "1.0.24",
"changelog": "Deployed new error handlers",
"description": "Improving error handling logic to deliver better user experience",
"user": "haney@newrelic.com",
"timestamp": "2018-05-24T21:23:05+00:00",
"links": {
"application": 43192210
}
}
...
]
}
Insights APIs
Two APIs for New Relic Insights let you add and retrieve custom event data: the Insights Query API and the Insights Insert API.
Here's an example request to issue a NRQL query against the Insights Query API.
curl -H "Accept: application/json" -H "X-Query-Key: YOUR_QUERY_KEY" "https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=YOUR_QUERY_STRING"
Here's an example request to insert events stored in a file named "events.json" into the Insights Insert API.
# events.json:
# [
# {
# "eventType":"ExampleEvent",
# "numExample":3,
# "strExample":"StringValue"
# },
# ...
# ]
cat events.json | curl -d @- -X POST -H "Content-Type: application/json" -H "X-Insert-Key: YOUR_KEY_HERE" https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/events
Agent APIs
New Relic APM, Browser, and Mobile agents include language-specific APIs that can extend functionality and data reporting.
Here's some example code to insert new custom attributes and custom events through the Java APM agent.
// Add a custom attribute to be added to existing APM events in Java
NewRelic.addCustomParameter("region", "us");
// Add a new custom event named "MyCustomEvent" to NRDB in Java
Map<String, Object> eventAttributes = new HashMap<String, Object>();
eventAttributes.put("region", "us");
eventAttributes.put("code", 5);
NewRelic.getAgent().getInsights().recordCustomEvent('MyCustomEvent', eventAttributes);
Infrastructure SDK
Report custom data from your hosts and build with the same Infrastructure SDK we use internally at New Relic.
This is an example main() method from a Go integration adding new metric, event, and inventory data.
func main() {
// Create Integration
i, err := integration.New(integrationName, integrationVersion, integration.Args(&args))
if err != nil {
log.Error(err.Error())
os.Exit(1)
}
entity := i.LocalEntity()
// Add an event
if args.All() || args.Events {
err = entity.AddEvent(event.New("restart", "status"))
if err != nil {
log.Error(err.Error())
}
}
// Add Inventory item
if args.All() || args.Inventory {
err = entity.SetInventoryItem("customInventory", "version", "3.0.1")
if err != nil {
log.Error(err.Error())
}
}
// Add Metric
if args.All() || args.Metrics {
m := entity.NewMetricSet("CustomSample")
err = m.SetMetric("myMetric", 1337, metric.GAUGE)
if err != nil {
log.Error(err.Error())
}
}
if err = i.Publish(); err != nil {
log.Error(err.Error())
}
}
GraphQL API
The New Relic GraphQL API explorer gives you easy, efficient access to the assets and data you want to query.
Here's an example GraphQL payload to request the available cloud vendors supported by New Relic Infrastructure integrations.
query cloudProviders {
actor {
account(id: YOUR_ACCOUNT_ID) {
cloud {
providers {
id
name
slug
}
}
}
}
}
This is an example GraphQL response payload for requested cloud vendors.
{
"data": {
"actor": {
"account": {
"cloud": {
"providers": [
{
"slug": "aws",
"name": "Amazon Web Services",
"id": 1
},
{
"slug": "gcp",
"name": "Google Cloud Platform",
"id": 5
},
{
"slug": "azure",
"name": "Microsoft Azure",
"id": 4
}
]
}
}
}
}
}