Splunk for Pivotal Tracker (beta)
This app allows you to view, analyze and report on all change activity in your Pivotal Tracker projects.
- By itself it is useful as a kind of “wayback machine” for Pivotal Tracker.
- If you take a more hands on approach it can become a powerful reporting layer to answer a wide range of questions about your Pivotal Tracker project.
- Last but not least, if you create “special” follower users in Pivotal Tracker and use these to effectively tag your stories and epics, this app empowers you to report on these custom labels and tags.
In this beta version you have to manually put your api token and project id into the python file of the scripted input, and you have to enable the scripted input in inputs.conf. Here’s how:
1) In $$SPLUNK_HOME/etc/apps/pivotal_tracker/bin, open up stories.py. You’ll see
PROJECT_ID = "999999" API_TOKEN = "999999999999999999" ACCOUNT_ID = "999999"
You’ll set these to the real values. Where do you find the real values?
a) from Pivotal tracker you can find out your project ID by going to the Project Overview page, then click “settings”. Scroll down a bit and under “Access” you’ll see the id listed there).
b) go to your Profile page in tracker, and scroll down to the bottom. You’ll see an API TOKEN section there.
c) go to your Accounts page and click “Manage Accounts”, then “Settings”. On the following page (called “Account Settings”), you’ll see an “ID” listed.
(In an upcoming version of the app this will be a modular input and all this configuration will be possible in the Administration UI of the app itself)
2) Now log into Splunk as an admin user and navigate to the pivotal tracker app. Once there click “Settings” in the top right, then “data inputs”, then “scripts”. Find the script called “$$SPLUNK_HOME/etc/apps/pivotal_tracker/bin/scripts/stories.py”. You’ll notice that the page says it is disabled. Click “Enable” to enable the script.
Custom Tag/Label Use Cases
If you have “fake” users in the system that you use to tag stories and epics by adding the fake users as followers, then you can use these field values to create custom fields for your reporting.
Let’s say that you have a follower you have created that is essentially a “business unit” within your organization that the story or epic pertains to.
There is a lookup in the app called users.csv, that you’ll find in $$SPLUNK_HOME/etc/apps/pivotal_tracker/lookups/users.csv . This app is populated and updated automatically by the scripted input, so if it does not exist right after the app is installed and the script is enabled, just wait 15 minutes.
Once the lookup exists, you will see your “fake” users in there alongside the regular users. Copy the file to a temporary location for the moment and edit it in Excel. In the top row of the csv file, we are going to add a new column to the file called “business_unit”. Type “business_unit” into the first empty cell in the top row. Then move your cursor down that column until you are in the first of your “fake” users. Type into that cell whatever business unit that user represents. Do so for all the “fake” users. Now save the file as a csv file, ignoring Excel’s warnings as you do so. Copy the users.csv file back to it’s original location.
Now back on the app homepage, and still logged in as an admin user, click “settings” in the top right. Then select “Lookups” and then “Automatic Lookups”. You’ll now see three rows – Click the one that says “pivotal_tracker : LOOKUP-followers”
Now you’ll see a screen with many textfields arranged in two columns. Under “Lookup output fields” the last pair of textfields will be empty. Type “business_unit” into BOTH fields. Click “Save” to save this edit.
From this point on, All epics and stories followed by any of these special followers will have a custom field on them called “business_unit”, and the value of the field will be the value you entered in the lookup.
If you have multiple independent layers of tagging like this – ie if there’s another label or tag that is orthogonal to your first one, just repeat these instructions and add a second or third column to the lookup, and add additional field(s) to the Automatic-lookup entry.
Note: Although the users.csv file is constantly updated by the app, the app will take care to respect any additional columns that you’ve added to it.