1. Create or sign into your New Relic account
New Relic uses API keys to authenticate and verify your identity. These keys allow approved people to:
- Access and query your data
Sign in to New Relic
or
Create a new New Relic account
2. Generate User API Key
You'll need a User API key to access NerdGraph, New Relic's GraphQL API. This key is essential for:
- Resolving the New Relic account connected to Hyphen
- Querying the account's entities, metrics, and logs
Go to API Keys UI to generate your key
The New Relic user that owns the key must be able to access the account and query the telemetry Hyphen will use. Hyphen does not require user-management, authentication-domain-management, or group-management permissions for observability queries.
Security Recommendations:
- Keep your API keys secure and treat them like passwords
- Rotate the User API key according to your organization's credential policy
- Remove or rotate keys when the owning user's access changes
3. Connect New Relic Account
Enter your User API key below to complete the integration. This key will be used to:
- Authenticate your account
- Resolve the New Relic account available to the key
- Query telemetry for connected apps and Kubernetes clusters
Configuration
| Field | Type | Description |
|---|---|---|
apiKey |
string (required) |
Secret New Relic API key provided by the user. Encrypted and stored as encryptedToken. |
accountId |
string |
Account ID pulled during integration config setup for reference. |
accountName |
string |
Account name pulled during integration config setup for reference. |
secrets |
object |
Built during integration setup containing: |
encryptedToken |
string |
Encrypted apiKey used to authenticate future requests. |
Connections
Table of Contents
Permission Group
Permission groups can connect to existing New Relic Groups or create new ones if no connection input is provided.
When creating a new Group in New Relic, the name will be the Hyphen Team name.
Configuration
| Field | Type | Description |
|---|---|---|
groupId |
string |
Unique group ID in the New Relic group. |
groupName |
string |
Group name in the New Relic group. |
Connection Input
Provide the New Relic group ID to connect to an existing Group.
Access
A Member connection will be added as a member when added to the group.
User
User connections link to existing Users in New Relic. If no input is provided, the member email will be used to try and find the existing User.
Configuration
| Field | Type | Description |
|---|---|---|
userId |
string |
Unique user ID in New Relic. |
email |
string |
Unique user email in New Relic. |
Connection Input
Provide the New Relic member email to connect to an existing User.
Kubernetes Observability
Kubernetes Observability connections let Hyphen Agent query New Relic metrics and logs for a registered cluster.
Before You Connect
- Install and configure the New Relic Kubernetes integration for the cluster.
- Wait for New Relic to receive its first Kubernetes cluster sample.
- Connect the New Relic account that receives the cluster's telemetry to the Hyphen organization.
Connection Input
Provide the cluster name configured when the New Relic Kubernetes integration was installed. Hyphen searches the connected account for a Kubernetes cluster sample with that name.
If the cluster sample has not arrived yet, the connection can remain in a retryable error state while New Relic begins ingesting telemetry. An incorrect cluster name produces a not-found error.
Hyphen may create the connection automatically when Horizon detects exactly one New Relic cluster name and the organization has exactly one New Relic integration. Otherwise, connect it from the registered cluster's Settings tab.
For complete setup instructions, see Kubernetes Observability.