{"id":31816717,"url":"https://github.com/splunk/splunk-heatwave-viz","last_synced_at":"2025-10-11T09:57:56.133Z","repository":{"id":6939401,"uuid":"8190909","full_name":"splunk/splunk-heatwave-viz","owner":"splunk","description":"A heatmap vizualization of bucketed ranged data over time.","archived":false,"fork":false,"pushed_at":"2013-04-01T21:41:48.000Z","size":1768,"stargazers_count":22,"open_issues_count":5,"forks_count":13,"subscribers_count":20,"default_branch":"master","last_synced_at":"2024-04-15T02:58:42.394Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/splunk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-02-14T00:17:41.000Z","updated_at":"2024-02-24T14:25:31.000Z","dependencies_parsed_at":"2022-08-26T06:41:57.366Z","dependency_job_id":null,"html_url":"https://github.com/splunk/splunk-heatwave-viz","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/splunk/splunk-heatwave-viz","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-heatwave-viz","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-heatwave-viz/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-heatwave-viz/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-heatwave-viz/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/splunk","download_url":"https://codeload.github.com/splunk/splunk-heatwave-viz/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/splunk%2Fsplunk-heatwave-viz/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279006749,"owners_count":26084185,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-11T02:00:06.511Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-11T09:57:50.022Z","updated_at":"2025-10-11T09:57:56.128Z","avatar_url":"https://github.com/splunk.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"splunk-heatwave-viz\n===================\n\n### What heatwave is:\nHeatwave is a time-based heatmap visualization. It operates on both historical/static data, \nas well as streamed/real-time data.\n\nFrom Heatwave, you can see the distribution of measures in bucketed ranges on the y-axis, \nwith time on the x-axis. Heatwave is vastly superior to the standard visualizations graphing \nderived measures avg/min/max/std, because Heatwave will show the actual spread and distribution \nof those measures (like a histogram) over time.\n\nA canonical use case is to measure performance metrics such as throughput, or latency values. \nBy using Heatwave, you can often see \"clusters\" that show up as \"bands\" over time, usually \nindicating underlying attribute influencing the metrics. From what you see in Heatwave, you can \nthen drill down or filter in order to find the root cause of performance issues evidenced by \nthe data.\n\n### What heatwave comes with:\nSplunk-heatwave-viz is both an app, and a module that you can integrate in your own dashboards. \nThe app comes with a visualization module and a drill down module that enables you to specify \ndrill down queries similar to that of splunk's own hidden search module. The module also comes \nwith a threshold search command with which you can set an upper and lower bound for the data \nto be visualized. The heatwave module and the drill down module comes with a set of parameters\nthat can be applied though the xml.\n\nHeatwave\n\ntitle: Specifies title for the heat map plot. \nupperColorLimit: Specifies upper color for the color range of the plotted heat map.\nlowerColorLimit: Specifies lower color for the color range of the plotted heat map.\ncolorScale: Specifies type of scale used for heat map coloring. Can be linear or log, \ndefault is log.\n\nHeatwaveDrilldown\n\nsearch: The literal search string HiddenSearch passes onto its child modules.\nearliest: This is used to define a beginning time range. It is expected if 'latest' is also \ndefined. It sets the start point of the time range to search within.\nlatest: This is used to define an ending time range. It is expected if 'earliest' is also \ndefined. It sets the ending point of the time range to search within.\n\n### Splunk:\nSplunk is the premier technology for gaining Operational Intelligence on Machine Data. Since it\ncan handle large volume of data at a fast rate, often times users will only want to analyze\nrecent data, and data that is beyond a certain range, or data in realtime.\n\nInstallation:\n-------------\n\n- [Download Splunk for your platform](http://www.splunk.com/download?r=productOverview).\n- Unpack/Install Splunk by running the downloaded files.\n- Follow the instruction on the screen.\n\nSplunk-heatwave-viz can either be installed directly from splunkbase or downloaded from github.\n- If you install it from splunkbase all you have to do is follow the instructions on your screen.\n- If you download it from splunkbase then extract the files into: SPLUNK_HOME/etc/apps/\n- If you download it from github then go to your apps directory: SPLUNK_HOME/etc/apps/\n\tDownload the app: git clone  https://github.com/splunk/splunk-heatwave-viz.git\n*You might have to restart splunk in order to apply the changes. \n\nUse case examples:\n-----------------\n\n### Unix\nIn the following example we will view the percentage load of a cpu over time,\nwith relation to the top 30 processes that are running during the specified timespan. \n\n![Unix 1](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/unix1.png \"Hearwave: Percentage cpu load per process\")\nIn the above image we see how Heatwave integrates well with other splunk modules such as the\nSearchBar and FlashTimeline. For example, if one would want to narrow the time range and only\nview the events between 3:30 and 3:35 it could be limited in the FlashTimeline and then passed\ndown to the Heatwave which is its child module.\n\n![Unix 2](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/sg2.png \"Heatwave: Drilldown to specific process\")\nThe above image illustrates the Heatwave drill down functionality. Here a parent Heatwave \ndisplays the top 30 processes running on a system during the specified time. As a user you can\ndrill down on a specific process and view its behavior with finer granularity. Which is \ndisplayed in the bottom Heatwave. \n\n![Unix 3](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/unix3.png \"Heatwave: Drilldown to specific data\")\nOne can then drill down further into for example a SimpleResultsTable in order to view the \nraw event information. \n\nThe above visualization and flow provides you with a superior way of visualizing metrics \ncompared to more standard metrics such as mean, min, max, and standard deviation. \n\n### SplunkGit\nThe following example visualizes the number of commit for a set of git-repositories.\n\n![Splunkgit 1](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/sg1.png \"Heatwave: All commits to all git-repos during all-time\")\nThe above image shows how you could visualize a set of git repositories and the number of commits\nthat have been made to them over a period of time. In this case all-time. The FlashTimeline \nillustrates the volume of commits over time, while the heatwave illustrates the intensity of\ncommits per repository over time.\n\n![Splunkgit 2](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/sg2.png \"Heatwave: Specify a time in FlashTimeline\")\nHere we see how the FlashTimeline can be used to specify a set timeframe for the data to be\npushed down to the Heatwave.\n\n![Splunkgit 3](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/sg3.png \"Heatwave: Drilldown on a specific time for all git-repos\")\nAfter the timespan has been pushed down the Heatwave visualizes the data.\n\n![Splunkgit 4](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/sg4.png \"HeatwaveL Drilldown on a specific git-repo\")\nWe can also drill down further to view the meta data of the buckets.\n\n### HadoopOps\n![HadoopOps](https://raw.github.com/splunk/splunk-heatwave-viz/develop/examples/hadoopOps1.png \"Heatwave: Dashboard four heatwaves visualizing different metrics\")\nHere you can see how one easily can visualize different metrics in a hadoop cluster before, \nduring, and after a job is run. The dashboard in the top left visualizes the CPU load for all \nnodes. The Heatwave in the top right visualizes the memory load. The Heatwave in the bottom left\nvisualizes disk usage, and the Heatwave in the bottom right is a visualization of I/O over all \nthe nodes. \n\nFrom these four Heatwave tiles we can notice a couple of different trends. For example when the \njob starts and ends, which nodes have overloaded and underloaded disk usage, as well as a I/O \nanomaly. \n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fsplunk-heatwave-viz","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsplunk%2Fsplunk-heatwave-viz","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsplunk%2Fsplunk-heatwave-viz/lists"}