monitoring deploymentsPDF version

Reporting task JSON file reference

These file samples provide a starting point on how to configure reporting tasks for Cloudera Data Flow. You can use the Cloudera CLI to add the created reporting tasks to Cloudera Data Flow flow deployments.

{
    "name": "AmbariReportingTask",
    "type": "org.apache.nifi.reporting.ambari.AmbariReportingTask",
    "properties": {
      "Application ID": "nifi",
      "Hostname": "${hostname(true)}",
      "Metrics Collector URL": "http://localhost:6188/ws/v1/timeline/metrics"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "1 min",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see AmbariReportingTask in the Cloudera Data Flow documentation.

{
    "name": "AzureLogAnalyticsProvenanceReportingTask",
    "type": "org.apache.nifi.reporting.azure.loganalytics.AzureLogAnalyticsProvenanceReportingTask",
    "properties": {
      "Job Name": "nifi_reporting_job",
      "Platform": "nifi",
      "Application ID": "nifi",
      "Log Analytics URL Endpoint Format": "https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01",
      "include-null-values": "false",
      "Batch Size": "1000",
      "Log Analytics Custom Log Name": "nifiprovenance",
      "Instance ID": "${hostname(true)}",
      "start-position": "beginning-of-stream",
      "Instance URL": "http://${hostname(true)}:8080/nifi"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see AzureLogAnalyticsProvenanceReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "AzureLogAnalyticsReportingTask",
    "type": "org.apache.nifi.reporting.azure.loganalytics.AzureLogAnalyticsReportingTask",
    "properties": {
      "Send JVM Metrics": "false",
      "Job Name": "nifi_reporting_job",
      "Application ID": "nifi",
      "Log Analytics Custom Log Name": "nifimetrics",
      "Instance ID": "${hostname(true)}",
      "Log Analytics URL Endpoint Format": "https://{0}.ods.opinsights.azure.com/api/logs?api-version=2016-04-01"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "1 min",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see AzureLogAnalyticsReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "ControllerStatusReportingTask",
    "type": "org.apache.nifi.controller.ControllerStatusReportingTask",
    "properties": {
      "Show Deltas": "true",
      "reporting-granularity": "five-minutes"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see ControllerStatusReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "DataDogReportingTask",
    "type": "org.apache.nifi.reporting.datadog.DataDogReportingTask",
    "properties": {
      "Metrics prefix": "nifi",
      "Datadog transport": "Datadog HTTP",
      "Environment": "dev"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see DataDogReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "MetricsEventReportingTask",
    "type": "org.apache.nifi.reporting.sql.MetricsEventReportingTask",
    "properties": {
      "dbf-default-precision": "10",
      "dbf-default-scale": "0"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see MetricsEventReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "MetricsReportingTask",
    "type": "org.apache.nifi.metrics.reporting.task.MetricsReportingTask",
    "properties": {},
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see MetricsReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "MonitorDiskUsage",
    "type": "org.apache.nifi.controller.MonitorDiskUsage",
    "properties": {
      "Directory Display Name": "Un-Named",
      "Threshold": "80%"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see MonitorDiskUsage in the Cloudera Data Flow documentation.

  {
    "name": "MonitorMemory",
    "type": "org.apache.nifi.controller.MonitorMemory",
    "properties": {
      "Memory Pool": "G1 Old Gen",
      "Usage Threshold": "65%"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see MonitorMemory in the Cloudera Data Flow documentation.

  {
    "name": "PrometheusReportingTask",
    "type": "org.apache.nifi.reporting.prometheus.PrometheusReportingTask",
    "properties": {
      "prometheus-reporting-task-metrics-endpoint-port": "9092",
      "prometheus-reporting-task-metrics-strategy": "All Components",
      "prometheus-reporting-task-instance-id": "${hostname(true)}",
      "prometheus-reporting-task-client-auth": "No Authentication",
      "prometheus-reporting-task-metrics-send-jvm": "false"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "60 sec",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see PrometheusReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "QueryNiFiReportingTask",
    "type": "org.apache.nifi.reporting.sql.QueryNiFiReportingTask",
    "properties": {
      "dbf-default-precision": "10",
      "sql-reporting-include-zero-record-results": "false",
      "dbf-default-scale": "0"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see QueryNiFiReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "ReportLineageToAtlas",
    "type": "org.apache.nifi.atlas.reporting.ReportLineageToAtlas",
    "properties": {
      "atlas-authentication-method": "basic",
      "filesystem-paths-level": "FILE",
      "kafka-kerberos-service-name": "kafka",
      "atlas-connect-timeout": "60 sec",
      "atlas-conf-create": "false",
      "provenance-start-position": "beginning-of-stream",
      "atlas-read-timeout": "60 sec",
      "provenance-batch-size": "1000",
      "aws-s3-model-version": "v2",
      "kafka-security-protocol": "PLAINTEXT",
      "nifi-lineage-strategy": "SimplePath"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see ReportLineageToAtlas in the Cloudera Data Flow documentation.

  {
    "name": "ScriptedReportingTask",
    "type": "org.apache.nifi.reporting.script.ScriptedReportingTask",
    "properties": {
      "Script Engine": "ECMAScript"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see ScriptedReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "SiteToSiteBulletinReportingTask",
    "type": "org.apache.nifi.reporting.SiteToSiteBulletinReportingTask",
    "properties": {
      "s2s-transport-protocol": "RAW",
      "Platform": "nifi",
      "include-null-values": "false",
      "Compress Events": "true",
      "Communications Timeout": "30 secs",
      "Instance URL": "http://${hostname(true)}:8080/nifi"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "1 min",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see SiteToSiteBulletinReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "SiteToSiteMetricsReportingTask",
    "type": "org.apache.nifi.reporting.SiteToSiteMetricsReportingTask",
    "properties": {
      "s2s-metrics-format": "ambari-format",
      "s2s-transport-protocol": "RAW",
      "s2s-metrics-application-id": "nifi",
      "s2s-metrics-hostname": "${hostname(true)}",
      "include-null-values": "false",
      "Compress Events": "true",
      "Communications Timeout": "30 secs",
      "Instance URL": "http://${hostname(true)}:8080/nifi"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see SiteToSiteMetricsReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "SiteToSiteProvenanceReportingTask",
    "type": "org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask",
    "properties": {
      "s2s-transport-protocol": "RAW",
      "Platform": "nifi",
      "include-null-values": "false",
      "Compress Events": "true",
      "Batch Size": "1000",
      "Communications Timeout": "30 secs",
      "start-position": "beginning-of-stream",
      "Instance URL": "http://${hostname(true)}:8080/nifi"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see SiteToSiteProvenanceReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "SiteToSiteStatusReportingTask",
    "type": "org.apache.nifi.reporting.SiteToSiteStatusReportingTask",
    "properties": {
      "s2s-transport-protocol": "RAW",
      "Platform": "nifi",
      "Component Name Filter Regex": ".*",
      "include-null-values": "false",
      "Compress Events": "true",
      "Batch Size": "1000",
      "Component Type Filter Regex": "(Processor|ProcessGroup|RemoteProcessGroup|RootProcessGroup|Connection|InputPort|OutputPort)",
      "Communications Timeout": "30 secs",
      "Instance URL": "http://${hostname(true)}:8080/nifi"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see SiteToSiteStatusReportingTask in the Cloudera Data Flow documentation.

  {
    "name": "StandardGangliaReporter",
    "type": "org.apache.nifi.reporting.ganglia.StandardGangliaReporter",
    "properties": {
      "Send JVM Metrics": "false",
      "Port": "8649",
      "Hostname": "localhost"
    },
    "propertyDescriptors": {},
    "scheduledState": "ENABLED",
    "schedulingPeriod": "5 mins",
    "schedulingStrategy": "TIMER_DRIVEN",
    "componentType": "REPORTING_TASK"
  }

For more information, see StandardGangliaReporter in the Cloudera Data Flow documentation.

We want your opinion

How can we improve this page?

What kind of feedback do you have?