New Relic Elixir Agent v1.11.0 NewRelic View Source
New Relic Agent - Public API
Link to this section Summary
Functions
Report a custom attribute on the current transaction
You must manually instrument outgoing HTTP calls to connect them to a Distributed Trace
Call within a transaction to prevent it from reporting
Report a Custom event to NRDB
To get detailed information about a particular process, you can install a Process sampler. You must tell the Agent about your process from within the process
Store information about the type of work the current span is doing
Set the name of the current transaction
Start a new "Other" Transaction
Link to this section Functions
add_attributes(custom_attributes) View Source
Report a custom attribute on the current transaction
NewRelic.add_attributes(foo: "bar")
create_distributed_trace_payload(type) View Source
You must manually instrument outgoing HTTP calls to connect them to a Distributed Trace.
The agent will automatically read request headers and detect if the request is a part of a Distributed Trace, but outgoing requests need an extra header:
dt_header_payload = NewRelic.create_distributed_trace_payload(:http)
HTTPoison.get(url, ["x-api-key": "secret"] ++ dt_header_payload)
Notes:
- Call
NewRelic.create_distributed_trace_payload
immediately before making the request since calling the function marks the "start" time of the request.
ignore_transaction() View Source
Call within a transaction to prevent it from reporting.
def index(conn, %{}) do
NewRelic.ignore_transaction()
send_resp(conn, :ok, '')
end
report_custom_event(type, attributes) View Source
Report a Custom event to NRDB.
NewRelic.report_custom_event("EventType", %{"foo" => "bar"})
sample_process() View Source
To get detailed information about a particular process, you can install a Process sampler. You must tell the Agent about your process from within the process.
For a GenServer
, this function call should be made in the init
function:
defmodule ImportantProcess do
use GenServer
def init(:ok) do
NewRelic.sample_process
{:ok, %{}}
end
end
Once installed, the agent will report ElixirSample
events with:
category = "Process"
message_queue_length
reductions
memory_kb
set_span(type, attributes) View Source
Store information about the type of work the current span is doing.
Options:
:generic, custom: attributes
:http, url: url, method: method, component: component
:datastore, statement: statement, instance: instance, address: address, hostname: hostname, component: component
set_transaction_name(name) View Source
Set the name of the current transaction.
The first segment will be treated as the Transaction namespace, and commonly contains the name of the framework.
In the following example, you will see /custom/transaction/name
in the Transaction list.
NewRelic.set_transaction_name("/Plug/custom/transaction/name")
start_transaction(category, name) View Source
Start a new "Other" Transaction.
This will begin monitoring the current process as an "Other" Transaction (ie: Not a "Web" Transaction). The first argument will be considered the "category", the second is the "name".
Examples:
NewRelic.start_transaction("GenStage", "MyConsumer/EventType")
NewRelic.start_transaction("Task", "TaskName")
Notes:
- Don't use this to track Web Transactions - for that,
use NewRelic.Transaction
in your Plug pipeline so that we can properly categorize as Web Transactions in the UI. - Do not use this for processes that live a very long time, doing so will risk a memory leak tracking attributes in the transaction!
- You can't start a new transaction within an existing one. Any process spawned inside a transaction belongs to that transaction.