Sharetary is a cross-origin events viewer. The name is neoterized from two terms "share" and "secretary".
This provides ability to watch various "events" stored into a Groonga server, in real time or analytically by two different views:
- Timeline view - You can watch events in real time, like Twitter or something. Newly added events will appear on the top of the view automatically.
- Archive view - You can watch events statically, with their relations. Related events are visible as a thread.
$ sudo npm install -g sharetary
$ sharetary-server
You must install Node.js and npm before installation. For example, on Ubuntu 14.04LTS:
$ sudo apt-get install nodejs nodejs-legacy npm
See sharetary-server --help for more details.
Sharetary doesn't provide ability to crawl events from sources. You need to crawl and load events by something other way.
In other words, you can use any data source for Sharetary, if you load them to the database in a common format described at this section.
Sharetary uses Groonga or Droonga as its backend. You simply have to define some tables with required columns (and load data to them):
_key(any type): Something to identify each event uniquely. For example, URI string, hash string, or others.type(TextorShortText): Indicates the type of each event. For example, an event indicating a "push" activity on the GitHub will have the stringpushas itstype.class(TextorShortText): Indicates the magnitude of each event. Three possible values:important,major,normal, andminor.importantandmajorevents will be highlighted in the view.tags(vector ofTags): Indicates tags associated to events. For example, events from GitHub activities will belong to any repository, so their repository name is suitable as a tag.title(TextorShortText): Short description of each event. For example, an event indicating a "push" activity on the GitHub will have itstitlelike: "Pushed N commits to the repository".description(TextorShortText): The main description of each event. For example, an event indicating a "commit" activity on the GitHub will have its commit message as itsdescription.extra_description(TextorShortText): The extra description of each event. It won't be rendered in the view, but will be shown in the tooltip of events. For example, an event indicating a "commit" activity on the GitHub will have its "diff" as itsextra_description.uri(TextorShortText): The related URI of each event.source_icon(TextorShortText): URI of the icon for the source of the event. For example, events from Github activities will have favicon's URI as itssoruce_icon.reply_uri(TextorShortText): The URI of an UI to post any reply for each event. For example, an event indicating a "commit" activity on the GitHub will have link to the comment form of the commit as itsreply_uri. If your crawler fetches posted comments from the UI also, then you'll see them as events related to the parent event.actor(Actors): Indicates the actor's name of each event. For example, an events from GitHub activity will have the account id as itsactor.timestamp(`Time'): The time when the event was triggered at. Events are sorted by this field in the archive view.created_at(`Time'): The time when the record of the event was loaded to the database. Events are sorted by this field in the timeline view.parent(TextorShortText): The_keyof another event. For example, an event indicating a "issue comment" activity on the GitHub will have the_keyof the "issue opened" event as itsparent.
icon(TextorShortText): URI of the icon for the tag.
uri(TextorShortText): The related URI of the actor.icon(TextorShortText): URI of the icon for the actor.class(TextorShortText): Indicates the magnitude of the actor. Two possible values:major,normal, andminor. Events triggered byminoractors will be shown with small text and lighter color in the view. For example, if you have events triggered by both students and teachers and you hope to see students' events mainly, then students aremajorand teachers areminor.
See the example schema also.
Any other column can be defined at each table table, as you like. Moreover, of course, any other table is also allowed in the database. Sharetary simply ignores them.
This section describes how to crawl GitHub activities by fluentd, on a Ubuntu 14.04 server.
-
Install Groonga with the instruction. (If you have your existing Groonga or Droonga, you can skip this step.)
-
Install fluentd and td-agent.
$ sudo apt-get install ntp $ sudo service ntp restart $ curl -L http://toolbelt.treasuredata.com/sh/install-ubuntu-trusty-td-agent2.sh | sudo sh $ sudo mkdir -p /var/spool/td-agent/buffer/ $ sudo chown -R td-agent:td-agent /var/spool/td-agent/ -
Install required fluentd plugins.
$ sudo td-agent-gem install fluent-plugin-github-activities $ sudo td-agent-gem install fluent-plugin-record-reformer $ sudo td-agent-gem install fluent-plugin-filter_typecast -
Install fluent-plugin-groonga. It requires some extra packages.
$ sudo apt-get install ruby ruby-dev build-essential $ sudo td-agent-gem install fluent-plugin-groonga -
Configure td-agent.
$ sudo vi /etc/td-agent/td-agent.confSee also the example configuration to crawl and load GitHub activities. It includes rules to convert fetched GitHub activities to Sharetary events.
It is recommended to put your GitHub access token in
td-agent.conf. You can obtain it here. -
Start td-agent.
$ sudo service td-agent start
By default the link "CSV" in "Export" menu exports only some major columns. If you need, you can customize columns of exported records. Steps to change exporting columns are:
- Copy the link location of the menu item.
- Paste it to the location bar of your browser.
- Add new query parameter
columnsand load it.- Any columns of the
Eventstable can be specified, like:...&columns=title - Multiple columns can be available as comma-separated list like:
...&columns=title,actor - Special column name
*(orall) is available to export all columns of theEventstable.
- Any columns of the
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent