Fluentd Configuration for New Relic

JFrog Platform Administration Documentation

Content Type
Administration / Platform
ft:sourceType
Paligo

Download and configure the relevant fluentd.conf files for New Relic

Configuration Steps for Artifactory

in the Environment Configuration section.

cd $JF_PRODUCT_DATA_INTERNAL
wget https://raw.githubusercontent.com/jfrog/log-analytics-newrelic/master/fluent.conf.rt
Logs data

Override the match directive (jfrog.**) of the downloaded fluent.conf.rt to send logs data to New Relic:

<match jfrog.**>
  @type newrelic
  license_key LICENSE_KEY
  logtype "jfrog_artifactory_logs"
</match>

Required: LICENSE_KEY is the License Key from New Relic in New Relic Setup.

OpenMetrics data

Override the source directive of the downloaded fluent.conf.rt in order to source metrics from Artifactory:

<source>
  @type jfrog_metrics
  @id metrics_http_jfrt
  tag jfrog.metrics.artifactory
  interval 5s
  metric_prefix 'jfrog.artifactory'
  jpd_url JPD_URL
  username ADMIN_USERNAME
  apikey JFROG_API_KEY
  token JFROG_ACCESS_TOKEN
  target_platform "NEWRELIC"
  common_jpd COMMON_JPD
</source>

Required:

  • JPD_URL is the Artifactory JPD URL of the format http://<ip_address>

  • ADMIN_USERNAME is the Artifactory username for authentication

  • JFROG_API_KEY is the API Key for authentication

  • JFROG_ACCESS_TOKEN is the scoped token

  • COMMON_JPD is true for non-kubernetes installations or installations where JPD base URL is same to access both Artifactory and Xray (ex: https://sample_base_url/artifactory or https://sample_base_url/xray). Default value is false

Override the match directive of the downloaded fluent.conf.rt in order to send metrics to New Relic:

<match jfrog.metrics.**>
  @type jfrog_send_metrics
  target_platform "NEWRELIC"
  apikey LICENSE_KEY
  url "https://metric-api.newrelic.com/metric/v1"
</match>

Required:

  • LICENSE_KEY is the License Key from New Relic in New Relic Setup

  • URL replace if in EU region with https://metric-api.eu.newrelic.com/metric/v1. Default value is https://metric-api.newrelic.com/metric/v1

Configuration Steps for Xray

Download the Xray fluentd configuration file to a directory the user has permissions to write, such as the $JF_PRODUCT_DATA_INTERNAL locations discussed above in the Environment Configuration section.

cd $JF_PRODUCT_DATA_INTERNAL
wget https://raw.githubusercontent.com/jfrog/log-analytics-newrelic/master/fluent.conf.xray
Logs and Violation data

Override the source directive of the downloaded fluent.conf.xray to pull Xray Violations:

<source>
  @type jfrog_siem
  tag jfrog.xray.siem.vulnerabilities
  jpd_url JPD_URL
  username ADMIN_USERNAME
  apikey JFROG_API_KEY
  pos_file_path "#{ENV['JF_PRODUCT_DATA_INTERNAL']}/log/jfrog_siem.log.pos"
  from_date "2016-01-01"
</source>

Required:

  • JPD_URL is the Artifactory JPD URL of the format http://<ip_address> with is used to pull Xray Violations

  • ADMIN_USERNAME is the Artifactory username for authentication

  • JFROG_API_KEY is the API Key for authentication

Optional: If not specified, value is set to current date. Setting from_date value will result in violations from the specified date

Override the match directive of the downloaded fluent.conf.xray to send Logs and Violations to New Relic:

<match jfrog.**>
  @type newrelic
  license_key LICENSE_KEY
  logtype "jfrog_artifactory_logs"
</match>

Required: LICENSE_KEY is the License Key from New Relic in New Relic Setup.

OpenMetrics data

Override the source directive of the downloaded fluent.conf.xray in order to source metrics from Xray:

<source>
  @type jfrog_metrics
  @id metrics_http_jfrt
  tag jfrog.metrics.xray
  interval 5s
  metric_prefix 'jfrog.xray'
  jpd_url JPD_URL
  username ADMIN_USERNAME
  apikey JFROG_API_KEY
  target_platform "NEWRELIC"
</source>

Required:

  • JPD_URL is the Artifactory JPD URL of the format http://<ip_address> with is used to pull Xray Violations

  • ADMIN_USERNAME is the Artifactory username for authentication

  • JFROG_API_KEY is the API Key for authentication

Override the match directive of the downloaded fluent.conf.rt in order to send metrics to New Relic:

<match jfrog.metrics.**>
  @type jfrog_send_metrics
  target_platform "NEWRELIC"
  apikey LICENSE_KEY
  url "https://metric-api.newrelic.com/metric/v1"
</match>

Required:

  • LICENSE_KEY is the License Key from New Relic in ???

  • URL replace if in EU region with https://metric-api.eu.newrelic.com/metric/v1. Default value is https://metric-api.newrelic.com/metric/v1

Configuration Steps for Nginx

Download the Nginx fluentd configuration file to a directory the user has permissions to write, such as the $JF_PRODUCT_DATA_INTERNAL locations discussed above in the Environment Configuration section.

cd $JF_PRODUCT_DATA_INTERNAL
wget https://raw.githubusercontent.com/jfrog/log-analytics-newrelic/master/fluent.conf.nginx

Override the match directive(last section) of the downloaded fluent.conf.nginx with the details given below:

<match jfrog.**>
  @type newrelic
  license_key LICENSE_KEY
  logtype "jfrog_nginx_logs"
</match>

Required: LICENSE_KEY is the License Key from New Relic in New Relic Setup

Configuration Steps for Mission Control

Download the Mission Control fluentd configuration file to a directory the user has permissions to write, such as the $JF_PRODUCT_DATA_INTERNAL locations discussed above in the Environment Configuration section

cd $JF_PRODUCT_DATA_INTERNAL
wget https://raw.githubusercontent.com/jfrog/log-analytics-newrelic/master/fluent.conf.missioncontrol

Override the match directive(last section) of the downloaded fluent.conf.missioncontrol with the details given below:

<match jfrog.**>
  @type newrelic
  license_key LICENSE_KEY
  logtype "jfrog_missioncontrol_logs"
</match>

Required: LICENSE_KEY is the License Key from New Relic in New Relic Setup.

Configuration Steps for Distribution

Download the distribution fluentd configuration file to a directory the user has permissions to write, such as the $JF_PRODUCT_DATA_INTERNAL locations discussed above in the Environment Configuration section.

cd $JF_PRODUCT_DATA_INTERNAL
wget https://raw.githubusercontent.com/jfrog/log-analytics-newrelic/master/fluent.conf.distribution
Override the match directive(last section) of the downloadedfluent.conf.distributionwith the details given below:
<match jfrog.**>
  @type newrelic
  license_key LICENSE_KEY
  logtype "jfrog_distribution_logs"
</match>

Required: LICENSE_KEY is the License Key from New Relic in New Relic Setup.

Configuration Steps for Pipelines

Download the pipelines fluentd configuration file to a directory the user has permissions to write, such as the $JF_PRODUCT_DATA_INTERNAL locations discussed above in the Environment Configuration section.

cd $JF_PRODUCT_DATA_INTERNAL
wget https://raw.githubusercontent.com/jfrog/log-analytics-newrelic/master/fluent.conf.pipelines
Override the match directive(last section) of the downloadedfluent.conf.pipelineswith the details given below:
<match jfrog.**>
  @type newrelic
  license_key LICENSE_KEY
  logtype "jfrog_pipelines_logs"
</match>

Required: LICENSE_KEY is the License Key from New Relic in New Relic Setup.