Script package that exposes captured IBM Cloud activity for the last day and last week for those activities that emit to the bot.activity
identifier with the appropriate activity document.
activity document:
var activityDoc = {
app_name: 'app_name',
app_guid: 'app_guid',
space_guid: 'space_guid',
space_name: 'space_name',
event_type: 'event_type'
};
If you are new to Hubot visit the getting started content to get a basic bot up and running. Next, follow these steps for adding this external script into your hubot:
cd
into your hubot directorynpm install ibmcloud-activity --save
ibmcloud-activity
to your external-scripts.json
HUBOT_AUDIT_ENDPOINT=<ElasticSearch endpoint>
UUID=<container uuid>
USAGE_CHART_DISABLED=<1 - to disable chart>
hubot activity help
- Show available activity commands.hubot activity today
- Displays statistics of the bot activity today.hubot activity this week
- Displays statistics of the bot activity this week.Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:
This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.
Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:
config
folder in root of this project.env
in the config
folder, with the following contents:
export HUBOT_AUDIT_ENDPOINT=<ElasticSearch endpoint>
export UUID=<container uuid>
export USAGE_CHART_DISABLED=<1 - to disable chart>
hubot-ibmcloud-formatter
to your external-scripts.json
file. Additionally, if you want to use hubot-help
to make sure your command documentation is correct. Create external-scripts.json
in the root of this project with the following contents:
[
"hubot-help",
"hubot-ibmcloud-formatter"
]
npm install
to obtain all the dependent node modules.Hubot supports a variety of adapters to connect to popular chat clients.
If you just want to use:
npm run start
See LICENSE.txt for license information.
Please check out our Contribution Guidelines for detailed information on how you can lend a hand.