Skip to content

Commit af148ab

Browse files
committed
docs: add IgnoreEntity usage
1 parent f21b070 commit af148ab

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/v3tov4.md

+16
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ The Go SDK v4 contains the following changes:
1010
* New metric data types: `count`, `summary`, `cumulative-count` and `cumulative-rate`.
1111
* Support for Prometheus Histogram and Summary metrics
1212
* LocalEntity has been replaced by HostEntity.
13+
* Support for disabling entity registration (IgnoreEntity).
1314
* Support for Go Modules
1415
* Removed support for protocols prior to v4.x.
1516

@@ -33,6 +34,7 @@ These are the most important changes:
3334
},
3435
"data":[ # List of objects containing entities, metrics, events and inventory
3536
{
37+
"ignore_entity": false,
3638
"entity":{ # this object is optional. If it's not provided, then the Entity will get
3739
# the same entity ID as the agent that executes the integration.
3840
"name":"redis:192.168.100.200:1234", # unique entity name per customer account
@@ -160,6 +162,20 @@ To add a tag just call
160162

161163
On both cases, if the `key` already exists the previous value will be overwritten with the new one.
162164

165+
#### Ignore entity
166+
167+
In older versions, the entity payload was decorated by the infra agent with an entity id to uniquely identify it in New
168+
Relic One. The entity registration method for New Relic has changed, the current default strategy is named entity
169+
synthesis, which can identify unique entities from its metadata and metrics name. You can find more information [here](https://docs.newrelic.com/docs/new-relic-one/core-concepts/what-entity-new-relic/).
170+
171+
All new integrations should be able to register using the entity synthesis strategy, but for backwards compatability and
172+
possible new host integrations, you can use the `IgnoreEntity` attribute for each entity.
173+
174+
By default, `IgnoreEntity` will be set to true, thus the agent will not register the entity. Nonetheless, if your entity
175+
needs to be registered or use the infra agent entity id just call:
176+
177+
`func (i *Entity) SetIgnoreEntity(value bool)`
178+
163179
### Metrics
164180

165181
#### Types

0 commit comments

Comments
 (0)