New Relic

https://docs.newrelic.com
Admin
New Relic is a comprehensive monitoring and observability platform that provides insights into...
Tokens:10,864,455
Snippets:84,526
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### StartAgent example

Source: https://docs.newrelic.com/docs/agents/net-agent/api-guides/guide-using-net-agent-api

Example call to start the agent.

```csharp
NewRelic.Api.Agent.NewRelic.StartAgent();
```

--------------------------------

### Example: create deployment with guid and version

Source: https://docs.newrelic.com/docs/change-tracking/change-tracking-cli

Example command to create a deployment with a specified entity GUID and version. Replace INSERT_YOUR_GUID_HERE and <1.0.0> with actual values.

```bash
newrelic entity deployment create --guid INSERT_YOUR_GUID_HERE --version <1.0.0>
```

--------------------------------

### Helm install example with OpenShift registry

Source: https://docs.newrelic.com/docs/synthetics/synthetic-monitoring/private-locations/install-job-manager.md

Example Helm install command using an OpenShift image registry URL and a custom tag.

```shell
helm install synthetics-kevin newrelic/synthetics-job-manager -n synthetics --set synthetics.privateLocationKey=<PRIVATE_LOC_KEY>   --set node-api-runtime.image.repository=default-route-openshift-image-registry.apps-crc.testing/synthetics/synthetics-node-api-runtime --set node-api-runtime.appVersionOverride=custom
```

--------------------------------

### Quick start: Initialize, predict, record

Source: https://docs.newrelic.com/docs/mlops/bring-your-own/getting-started-byo.md

Quick start example showing the three main steps: initializing monitoring, running predictions, and recording inference data.

```python
# 1: Initialize the monitoring
ml_monitor = MLPerformanceMonitoring(...)

# 2: Add your algorithm
y = my_model.predict(X)

# 3: Record your data
ml_monitor.record_inference_data(X, y)
```

--------------------------------

### Kotlin example: start and end interaction

Source: https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/start-interaction.md

Example of starting an interaction named 'Getting Data From Server' in a Kotlin Android activity, then ending it after a network request completes.

```kotlin
class MainActivity : AppCompatActivity() {

  ...
  var client: OkHttpClient = OkHttpClient();

      binding.fab.setOnClickListener { view ->

          val interActionId = NewRelic.startInteraction("Getting Data From Server")

              lifecycleScope.launch(Dispatchers.IO) {
                  val result = getRequest()
                  NewRelic.endInteraction(interActionId)
              }
          }
      }
    ...
```

--------------------------------

### StartInteraction example (C#)

Source: https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/start-interaction.md

Shows how to start an interaction, perform an HTTP GET request, and end the interaction with the returned ID. The example uses CrossNewRelic.Current.GetHttpMessageHandler() to create an HttpClient.

```csharp
HttpClient myClient = new HttpClient(CrossNewRelic.Current.GetHttpMessageHandler());

string interactionId = CrossNewRelic.Current.StartInteraction("Getting data from service");

var response = await myClient.GetAsync(new Uri("https://jsonplaceholder.typicode.com/todos/1"));
if (response.IsSuccessStatusCode)
{
    var content = await response.Content.ReadAsStringAsync();
} 
else
{
    Console.WriteLine("Unsuccessful response code");
}

CrossNewRelic.Current.EndInteraction(interactionId);
```

--------------------------------

### Response for get workloads query

Source: https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-workloads-api-tutorials

Example response from the NerdGraph API for the get workloads query. It shows the structure of the returned data, including the workload GUID, name, and permalink.

```json
{
  "data": {
    "actor": {
      "entitySearch": {
        "results": {
          "entities": [
            {
              "guid": "MTY...NTY",
              "name": "Acme Telco - Fulfillment Chain",
              "permalink": "https://one.newrelic.com/redirect/entity/MTY...NTY"
            },
            ...
          ]
        }
      }
    }
  },
  "extensions": { ... }
}
```

--------------------------------

### Initialize C SDK and create app

Source: https://docs.newrelic.com/docs/agents/c-sdk/install-configure/install-c-sdk-compile-link-your-code

Initialize the SDK and create an application to connect to the daemon. Waits up to 10 seconds for the connection.

```c
newrelic_app_t* app;


/* ... */


if (!newrelic_init(NULL, 0)) {
  printf("Error connecting to daemon.\n");
  return -1;
}


/* Wait up to 10 seconds for the SDK to connect to the daemon */
app = newrelic_create_app(config, 10000);
newrelic_destroy_app_config(&config);

```

--------------------------------

### noticeNetworkFailure example with NewRelic.NetworkFailure.BadURL

Source: https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/network-request-failures.md

Example call to noticeNetworkFailure using the NewRelic.NetworkFailure.BadURL failure type. It records a failed GET request to 'https://github.com' with the current time as both start and end time.

```js
NewRelic.noticeNetworkFailure('https://github.com', 'GET', Date.now(), Date.now(), NewRelic.NetworkFailure.BadURL);
```

--------------------------------

### Config file example with two instances

Source: https://docs.newrelic.com/docs/create-integrations/infrastructure-integrations-sdk/specifications/host-integrations-legacy-configuration-format

Example configuration file defining two integration instances for com.myorg.nginx, each with its own name, command, arguments, and labels.

```yaml
integration_name: com.myorg.nginx
instances:
  - name: nginx1.myorg.com-metrics
    command: metrics
    arguments:
      status_url: http://one.url/status
    labels:
      environment: production
      role: load_balancer
 - name: nginx2.myorg.com-metrics
   command: metrics
   arguments:
     status_url: http://another.url/status
   labels:
     environment: production
     role: load_balancer
```

--------------------------------

### GET a list of infrastructure conditions with pagination

Source: https://docs.newrelic.com/docs/infrastructure/infrastructure-alerts/rest-api-calls-new-relic-infrastructure-alerts

Use this cURL command to retrieve a specific page of infrastructure conditions. The offset and limit parameters control pagination; this example gets 10 conditions starting after the first 50.

```bash
$
curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions?policy_id=111111&offset=50&limit=10"
```

--------------------------------

### NoticeHttpTransaction example (C#)

Source: https://docs.newrelic.com/docs/mobile-monitoring/new-relic-mobile/mobile-sdk/network-request-success.md

Shows a call to CrossNewRelic.Current.NoticeHttpTransaction with a GET request to https://newrelic.com, status 200, start and end times in milliseconds, and empty response body.

```csharp
CrossNewRelic.Current.NoticeHttpTransaction(
  "https://newrelic.com",
  "GET",
  200,
  DateTimeOffset.Now.ToUnixTimeMilliseconds(),
  DateTimeOffset.Now.ToUnixTimeMilliseconds() + 100,
  0,
  1000,
  ""
);
```

--------------------------------

### Config file example with one instance

Source: https://docs.newrelic.com/docs/create-integrations/infrastructure-integrations-sdk/specifications/host-integrations-legacy-configuration-format

Example configuration file defining a single integration instance for com.myorg.nginx, including command, arguments, and labels.

```yaml
integration_name: com.myorg.nginx
instances:
  - name: nginx1.myorg.com-metrics
    command: metrics
    arguments:
      status_url: http://127.0.0.1/status
    labels:
      environment: production
      role: load_balancer
```

--------------------------------

### Initialize C SDK and create app

Source: https://docs.newrelic.com/docs/apm/agents/c-sdk/install-configure/install-c-sdk-compile-link-your-code

Initialize the C SDK with newrelic_init, create an app with newrelic_create_app, and destroy the config. The example waits up to 10 seconds for the SDK to connect to the daemon.

```c
newrelic_app_t* app;


/* ... */


if (!newrelic_init(NULL, 0)) {
  printf("Error connecting to daemon.\n");
  return -1;
}


/* Wait up to 10 seconds for the SDK to connect to the daemon */
app = newrelic_create_app(config, 10000);
newrelic_destroy_app_config(&config);
```

--------------------------------

### Dockerfile example for installing PHP agent

Source: https://docs.newrelic.com/docs/apm/agents/php-agent/advanced-installation/docker-other-container-environments-install-php-agent.md

A Dockerfile that installs the New Relic PHP agent in a php:fpm container. It downloads the latest agent version, detects the libc provider, runs the installer, and configures the agent to use NEW_RELIC_LICENSE_KEY and NEW_RELIC_APP_NAME environment variables. Requires setting these environment variables when starting the container.

```dockerfile
FROM php:fpm

# Install the latest New Relic PHP Agent
RUN \
    cd /tmp \
    # Discover the latest released version:
    && export NEW_RELIC_AGENT_VERSION=$(curl -s https://download.newrelic.com/php_agent/release/ | grep -o '[1-9][0-9]\?\(\.\[0-9]\+\)\{3\}' | head -n1) \
    # Discover libc provider
    && export NR_INSTALL_PLATFORM=$(ldd --version 2>&1 | grep -q musl && echo "linux-musl" || echo "linux") \
    # Download the discovered version:
    && curl -o newrelic-php-agent.tar.gz https://download.newrelic.com/php_agent/release/newrelic-php5-${NEW_RELIC_AGENT_VERSION}-${NR_INSTALL_PLATFORM}.tar.gz \
    # Install the downloaded agent:
    && tar xzf newrelic-php-agent.tar.gz \
    && NR_INSTALL_USE_CP_NOT_LN=1 NR_INSTALL_SILENT=0 ./*/newrelic-install install \
    # Configure the agent to use license key from NEW_RELIC_LICENSE_KEY env var:
    && sed -ie 's/[ ;]*newrelic.license[[:space:]]=.*/newrelic.license=${NEW_RELIC_LICENSE_KEY}/' $(php-config --ini-dir)/newrelic.ini \
    # Configure the agent to use app name from NEW_RELIC_APP_NAME env var:
    && sed -ie 's/[ ;]*newrelic.appname[[:space:]]=.*/newrelic.appname=${NEW_RELIC_APP_NAME}/' $(php-config --ini-dir)/newrelic.ini \
    # Cleanup temporary files:
    && rm newrelic-php-agent.tar.gz && rm -rf newrelic-php5-*-linux
```

--------------------------------

### Cancel queued Jenkins build workflow

Source: https://docs.newrelic.com/docs/workflow-automation/setup-and-configure/actions-catalog/jenkins/jenkins-queue.md

Workflow example that triggers a Jenkins build and then cancels it before it starts executing. Uses the jenkins.job.trigger action to get the queueId and then the jenkins.queue.cancel action to cancel it.

```yaml
name: cancel-queued-jenkins-build
description: 'Trigger a Jenkins build then cancel it before it starts executing'
steps:
  - name: trigger_build
    type: action
    action: jenkins.job.trigger
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      jobName: "my-application-build"
      selectors:
        - name: "queueId"
          expression: ".queueId"
    next: cancel_build

  - name: cancel_build
    type: action
    action: jenkins.queue.cancel
    version: 1
    inputs:
      authToken: ${{ :secrets:jenkinsAuthToken }}
      url: "https://jenkins.example.com"
      queueId: ${{ .steps.trigger_build.outputs.queueId }}
    next: end
```

--------------------------------

### Create setup folder

Source: https://docs.newrelic.com/docs/infrastructure/infrastructure-agent/linux-installation/infra-agent-as-container.md

Command to create a directory for storing configuration files.

```bash
mkdir ~/newrelic-infra-setup
```

--------------------------------

### Create the PHP Guestbook application with Redis

Source: https://docs.newrelic.com/docs/integrations/kubernetes-integration/link-apps-services/tutorial-monitor-redis-running-kubernetes

Run this kubectl command to deploy the example Redis application from the Kubernetes examples repository. This sets up the environment needed for the tutorial.

```bash
$
kubectl create -f https://raw.githubusercontent.com/kubernetes/examples/master/guestbook/all-in-one/guestbook-all-in-one.yaml

```

--------------------------------

### Get key transaction performance metrics with NRQL

Source: https://docs.newrelic.com/docs/apis/rest-api-v2/migrate-to-nerdgraph.md

Use this NerdGraph NRQL query to get equivalent performance metrics (for example, throughput) for a key transaction, using the key transaction's metric name. It queries the Metric data type and filters by entity GUID.

```graphql
{
  actor {
    nrql(
      accounts: [YOUR_ACCOUNT_ID]
      query: "SELECT average(newrelic.timeslice.value) * 1000 AS responseTimeAverage, rate(count(newrelic.timeslice.value), 1 minute) AS throughput FROM Metric WHERE entity.guid = 'ENTITY_GUID' SINCE 30 minutes AGO TIMESERIES"
    ) {
      results
    }
  }
}
```
Tokens:
Raw