newrelic/newrelic-salesforce-exporter repository overview

⁠Supported tags

• latest, v3
• legacy, v2

And specific versions.

⁠What is newrelic-salesforce-exporter?

The Salesforce Exporter offers an integration to process and forward Salesforce data to New Relic as either logs or events. It is composed of two different integrations:

• Event Logs integration⁠
• Event Stream integration⁠

Please refer to the corresponding readme file for further details.

⁠How to use this image?

First set up a correct configurations for config.yml, and other files you may need before proceeding.

For the Event Log integration use the following Dockerfile:

FROM newrelic/newrelic-salesforce-exporter

COPY config.yml ./

# Add any other file you need:
#   COPY event_type_fields.yml ./
#   ...

CMD ["./nr-salesforce-eventlog"]

For the Event Stream integration use the following Dockerfile:

FROM newrelic/newrelic-salesforce-exporter

COPY config.yml ./

CMD ["./nr-salesforce-stream"]

To create the image, go to the root of the repo folder, and run:

docker build -f path/to/Dockerfile --tag sfdc-eventlog:MY_VERSION .

docker build -f path/to/Dockerfile --tag sfdc-eventstream:MY_VERSION .

Set MY_VERSION accordingly.

And run it:

docker run sfdc-eventlog:MY_VERSION

docker run sfdc-eventstream:MY_VERSION

Add -d after docker run to run in detached mode.

⁠About Legacy (v2) and Latest (v3) versions

This integration had a major upgrade from v2 to v3, which was a complete rewrite of the integration and introduced multiple breaking changes. Since then, v2 entered in maintenance mode, and will only receive bug and security fixes until the EOL.

To access to legacy code and documentation, check out the v2 branch⁠ on github.

The way to use the v2 docker image is a bit different:

FROM newrelic/newrelic-salesforce-exporter:v2

#
# Copy your config file into the base directory.
# Adjust the local path as necessary.
#
COPY ./config.yml .

#
# If needed, copy your New Relic Python agent config file into the base directory.
# Adjust the local path as necessary.
#
#COPY ./newrelic.ini .

#
# If needed, copy your event type fields mapping file into the base directory.
# Adjust the local path as necessary.
#
#COPY ./event_type_fields.yml .

#
# If needed, copy your numeric fields mapping file into the base directory.
# Adjust the local path as necessary.
#
#COPY ./numeric_fields.yml .

Check out the official doc⁠ for more information on how to use docker with v2.