Attach a Nerdlet to an entity

One way for users to access your Nerdlet is by creating a launcher. The launcher opens a Nerdlet from the Apps page in New Relic. You can also provide access to your Nerdlet from an entity in your account.

In this guide, you'll learn how to attach your Nerdlet to your entities.

Before you begin

If you haven't already:

• Sign up for a New Relic account
• Install and configure the New Relic One CLI

Create a Nerdpack

$
nr1 update

$
nr1 create --type nerdpack --name entity-nerdlet

$
cd entity-nerdlet
$
nr1 nerdpack:serve

Attach your Nerdlet to entities

You've seen how you can access your Nerdlet from a launcher. Now, access your Nerdlet from your entities.

{
  "schemaType": "NERDLET",
  "id": "entity-nerdlet-nerdlet",
  "displayName": "EntityNerdletNerdlet",
  "description": "",
  "context": {
    "entities": []
  }
}

{
  "schemaType": "NERDLET",
  "id": "entity-nerdlet-nerdlet",
  "displayName": "EntityNerdletNerdlet",
  "description": "",
  "context": {
    "entities": [
      {
        "domain": "APM",
        "type": "APPLICATION"
      }
    ]
  }
}

Configure your entities context

The context.entities key in your Nerdlet's nr1.json file specifies which entities your Nerdlet should be attached to.

Specify an entity domain

Attach your Nerdlet to a certain entity domain by specifying the domain as one of the following values:

• APM: Application Performance Monitoring
• BROWSER: Browser
• INFRA: Infrastructure monitoring
• MOBILE: Mobile monitoring
• SYNTH: Synthetic monitoring

For example, attach your Nerdlet to all entities in the APM domain:

{
  "context": {
    "entities": [{ "domain": "APM" }]
  }
}

Attach your Nerdlet to all entities except those in a domain:

{
  "context": {
    "entities": [{ "domain": "!APM" }]
  }
}

Attach your Nerdlet to all entities in multiple domains:

{
  "context": {
    "entities": [{ "domain": "APM" }, { "domain": "BROWSER" }]
  }
}

Specify an entity type

Attach your Nerdlet to a certain entity type by specifying the type as one of the following values:

• APPLICATION
• HOST
• MONITOR

For example, attach your Nerdlet to all entities of the APPLICATION type:

{
  "context": {
    "entities": [{ "type": "APPLICATION" }]
  }
}

Attach your Nerdlet to all entities except those of a specified type:

{
  "context": {
    "entities": [{ "type": "!APPLICATION" }]
  }
}

Attach your Nerdlet to every entity whose type matches one of an array of types:

{
  "context": {
    "entities": [{ "type": "APPLICATION" }, { "type": "MONITOR" }]
  }
}

Specify entity tags

Attach your Nerdlet to entities that have a given tag.

For example, attach your Nerdlet to the entity which has a particular GUID:

{
  "context": {
    "entities": [
      {
        "tags": [
          {
            "key": "guid",
            "values": ["<SOME ENTITY GUID>"]
          }
        ]
      }
    ]
  }
}

Attach your Nerdlet to every entity which has particular accountId and uses the Python programming language:

{
  "context": {
    "entities": [
      {
        "tags": [
          {
            "key": "accountId",
            "values": ["<SOME ACCOUNT ID>"]
          },
          {
            "key": "language",
            "values": ["python"]
          }
        ]
      }
    ]
  }
}

Combine filters

When you filter the entities to which your Nerdlet will be added, you can combine domain, type, and tags:

{
  "context": {
    "entities": [
      {
        "domain": "APM",
        "type": "APPLICATION",
        "tags": [
          {
            "key": "language",
            "values": ["python"]
          }
        ]
      },
      {
        "domain": "SYNTH",
        "type": "MONITOR"
      },
      {
        "domain": "BROWSER"
      }
    ]
  }
}

In this example, you've attached your Nerdlet to:

• All APM applications whose metadata tags specify the python language
• AND all Synthetic monitors
• AND all Browser entities