icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.
Log4Shell Vulnerability: Information and guidance for you. Get resources.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading National Grid Carbon Intensity Add-on for Splunk
SHA256 checksum (national-grid-carbon-intensity-add-on-for-splunk_101.tgz) d079210548ea54d8410dbc9df3efd417a5f7b707fe77fc4f963ef38c68605e60
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

National Grid Carbon Intensity Add-on for Splunk

Splunk Cloud
Splunk Labs
This app is NOT supported by Splunk. Please read about what that means for you here.
Overview
Details
Description:
National Grid Carbon Intensity Add-on for Splunk enables the retrieval and indexing of data from National Grid’s Carbon Intensity API.

This API provides an indicative trend of regional carbon intensity of the electricity system in Great Britain (GB) 96+ hours ahead of real-time, in addition to current and historic data.

With accurate current carbon intensity for energy used (rather than high level conversion factors, often updated on an annual basis), organisations can have realtime indications on how they are tracking their progress towards reduction goals.

With carbon intensity forecast data, organisations can adjust the planned schedule of electricity intensive activities to minimize their carbon footprint.

Dashboards to analyse the returned data are provided in the Sustainability Toolkit for Splunk - https://splunkbase.splunk.com/app/6343/.

Setup:
See the Details tab for dependencies and setup instructions.

Privacy:
This app does not require PII nor does it send any data outside the Splunk environment.

Help:
While this app is not formally supported, the developer can be reached at mthomas@splunk.com (OR in splunk-usergroups slack, @mthomas). Responses are made on a best effort basis. Feedback is always welcome and appreciated!
(if you use the User Group approach, include: Learn more about splunk-usergroups slack here: https://docs.splunk.com/Documentation/Community/current/community/Chat#Join_us_on_Slack)

This Add-on implements calls to the following:

Get Carbon Intensity data for current half hour

  • Endpoint: https://api.carbonintensity.org.uk/intensity
  • Parameters: None
  • API Documentation: https://carbon-intensity.github.io/api-definitions/#get-intensit
  • How events are processed and saved
    • Events saved to Spunk: 1, for current half hour
    • Sourcetype: NG:carbonintensity
    • Default index: sustainability
    • _time: The timestamp in the returned event. This is defined in the sourcetype.
  • Default frequency of request: 1800 seconds / 30 minutes

Get Carbon Intensity data for current half hour for GB regions

  • Endpoint: https://api.carbonintensity.org.uk/regional
  • Parameters: None
  • API Documentation: https://carbon-intensity.github.io/api-definitions/#get-regional
  • How events are processed and saved
    • Events saved to Spunk: 1, for current half hour
    • Sourcetype: NG:carbonintensity:byregion
    • Default index: sustainability
    • _time: The timestamp in the returned event. This is defined in the sourcetype.
  • Default frequency of request: 1800 seconds / 30 minutes

Get Carbon Intensity data 48hrs forwards from specific datetime

  • Endpoint: https://api.carbonintensity.org.uk/intensity/{from}/fw48h
  • Parameters: “from” is set to the date, hour and minute when the API call is made
  • API Documentation: https://carbon-intensity.github.io/api-definitions/#get-intensity-from-fw48h
  • How events are processed and saved
    • Events saved to Spunk: 96, one per half hour period in the next 48 hours
    • Sourcetype: NG:carbonintensity:forecast
    • Default index: sustainability
    • _time: The time the events are saved to Splunk. This is defined in the sourcetype.
  • Default frequency of request: 86400 seconds / 1 day

Get Carbon Intensity data for next 48h for GB regions

  • Endpoint: https://api.carbonintensity.org.uk/regional/intensity/{from}/fw48h
  • Parameters: “from” is set to the date, hour and minute when the API call is made
  • API Documentation: https://carbon-intensity.github.io/api-definitions/#get-regional-intensity-from-fw48h
  • How events are processed and saved
    • Events saved to Spunk: 96, one per half hour period in the next 48 hours
    • Sourcetype: NG:carbonintensity:forecast:byregion
    • Default index: sustainability
    • _time: The time the events are saved to Splunk. This is defined in the sourcetype.
  • Default frequency of request: 86400 seconds / 1 day

The following table can be used as a quick comparison of the details provided above

Get data for current half hour Get data for current half hour for GB regions Get data 48hrs forwards from specific datetime Get data for next 48h for GB regions
Endpoint of https://api.carbonintensity.org.uk /intensity /regional /intensity/{from}/fw48h /regional/intensity/{from}/fw48h
Parameters None None “from” is set to the date, hour and minute when call is made “from” is set to the date, hour and minute when call is made
API Documentation #get-intensity #get-regional #get-intensity-from-fw48h #get-regional-intensity-from-fw48h
Event Count A single event is returned A single event is returned 96, one per half hour period in the next 48 hours 96, one per half hour period in the next 48 hours
Sourcetype NG:carbonintensity NG:carbonintensity:byregion NG:carbonintensity:forecast NG:carbonintensity:forecast:byregion
Default index sustainability sustainability sustainability sustainability
_time The timestamp from returned event The timestamp from returned event The time the events are saved to Splunk The time the events are saved to Splunk
Default request frequency 30 minutes 30 minutes 1 day 1 day

Installation

Splunk Cloud

This can be installed on your cloud environment, either as self-service or through a request to Splunk Support.

Splunk Enterprise

Following best practise, the Add-on should be installed on a Heavy Forwarder, to make the API requested.
Sourcetype definitions should be installed on the Indexers and Search Heads.

Setup

Enable any of the required inputs listed above, after changing index names and request frequency if required.

Data Analysis

Dashboards to analyse the returned data are provided in the Sustainability Toolkit for Splunk.

Release Notes

Version 1.0.1
May 26, 2022

Initial release


Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.