[jbosstools-dev] Hooking up Fuse Tools and SwitchYard with usage tracking

Max Rydahl Andersen manderse at redhat.com
Sat Mar 12 04:20:18 EST 2016 

On 11 Mar 2016, at 22:33, Brian Fitzpatrick wrote:

> Thanks guys for updating the docs - that helps a ton. And I'll get 
> this
> into SwitchYard soon. :)

Great!

And I just did a small edit to clarify we are *not* tracking users we 
are tracking usage.
Meaning users optin to submit statistics/events - they are not opting in 
to be tracked.

Subtle, but very important distinction on what we are doing here.

/max
>
> On Fri, Mar 11, 2016 at 1:15 PM, Alexey Kazakov <alkazako at redhat.com> 
> wrote:
>
>> Lars, you are correct.
>> Having a dependency to the usage plugin in your manifest is enough to
>> enable usage tracking itself (if users agreed to enable it).
>> The snippet Max mentioned is needed to track some specific events 
>> (and
>> that's snippet is not complete btw, see the doc). I guess Max just 
>> meant
>> that if you have code like that it means you already have all needed
>> dependencies etc, so the usage should work :)
>>
>> If you just added the needed dependencies then Usage will start 
>> tracking
>> all basic stuff (startups, OSs, etc.) including all Wizards IDs. When 
>> a
>> user click Finish on the Wizard then we count this event. So we have 
>> all
>> used wizard IDs and how many times there were used.
>> But if you need to track something else then you have to register a 
>> new
>> event type and track it where needed. See the doc.
>>
>> I've updated the doc and removed this confusing stuff about the
>> "UsageReporter.getInstance().countEvent(eventType.event(label,
>> value));" snippet.
>> I also added the section about the Wizard IDs tracking.
>>
>> Thanks.
>>
>> On 03/11/2016 02:03 PM, Lars Heinemann wrote:
>>>  From what I read here I can say we do not have a line
>>> like UsageReporter.getInstance().countEvent(...) anywhere in the 
>>> Fuse
>>> Tooling. Back in time when asking how to get tracked if our tooling 
>>> is
>>> installed / used the answer was put dependency to usage bundle into
>>> manifest. I did that and nothing more so far.
>>>
>>> Lars
>>>
>>> -------- Weitergeleitete Nachricht --------
>>> Von: Nick Boldt <nboldt at redhat.com>
>>> An: Max Rydahl Andersen <manderse at redhat.com>
>>> Kopie: tools-dev <jbosstools-dev at lists.jboss.org>
>>> Betreff: Re: [jbosstools-dev] Hooking up Fuse Tools and SwitchYard 
>>> with
>>> usage tracking
>>> Datum: Fri, 11 Mar 2016 13:44:48 -0500
>>>
>>> I have digested Max's comments here into the doc:
>>>
>>> https://github.com/jbosstools/jbosstools-devdoc/blob/master/api/usage/u
>>> sage_api.adoc#enabling-usage-tracking-in-your-plugin
>>>
>>> Feel free to contribute fixes to that doc if you encounter more 
>>> stuff
>>> you feel needs to be there.
>>>
>>> On Fri, Mar 11, 2016 at 12:47 PM, Max Rydahl Andersen
>>> <manderse at redhat.com> wrote:
>>>> On 11 Mar 2016, at 18:31, Brian Fitzpatrick wrote:
>>>>
>>>>> Awesome. Thanks Max! Appreciate the guidance.
>>>> tip - if its the first time you are adding counting to a plugin for
>>>> usage tracking
>>>> I recommend you ask Alexey, Fred or me to review it to catch too
>>>> aggressive or too passive counting issues.
>>>>
>>>> /max
>>>>
>>>>>
>>>>> On Fri, Mar 11, 2016 at 10:23 AM, Max Rydahl Andersen
>>>>> <manderse at redhat.com>
>>>>> wrote:
>>>>>
>>>>>> On 11 Mar 2016, at 18:12, Brian Fitzpatrick wrote:
>>>>>>
>>>>>> When you say "Wizards should already be there as long as SY and
>>>>>> Fuse
>>>>>> depend
>>>>>> on the usage plug-in." what do you mean?
>>>>>>
>>>>>> hmm - just realised that is missing from the docs...pretty sure
>>>>>> it
>>>>>> was
>>>>>> there at some point.
>>>>>>
>>>>>> For basic enablement add dependency to: org.jboss.tools.usage
>>>>>> like in
>>>>>> https://github.com/jbosstools/jbosstools-server/blob/jbosstools-4
>>>>>> .2.0.Beta1x/as/plugins/org.jboss.ide.eclipse.as.ui/META-
>>>>>> INF/MANIFEST.MF#L67
>>>>>>
>>>>>> Can I interpret that as meaning if our tools ping for daily
>>>>>> events as
>>>>>> in
>>>>>> the example below, our wizard usage will already be recorded?
>>>>>>
>>>>>> Wizard usage will be recorded as soon as the usage reporter is
>>>>>> installed
>>>>>> (and of course if the user said yes to be tracked)
>>>>>>
>>>>>> UsageReporter.getInstance().countEvent(eventType.event(label,
>>>>>> value));
>>>>>>
>>>>>> If you have code like the above then you for sure should already
>>>>>> be
>>>>>> covered for sure ;)
>>>>>>
>>>>>> /max
>>>>>>
>>>>>> On Fri, Mar 11, 2016 at 10:08 AM, Max Rydahl Andersen
>>>>>> manderse at redhat.com
>>>>>> wrote:
>>>>>>
>>>>>> On 11 Mar 2016, at 18:01, Brian Fitzpatrick wrote:
>>>>>>
>>>>>> Hi all,
>>>>>>
>>>>>> Back in January I received great help from Alexey and Max to help
>>>>>> me
>>>>>> take
>>>>>> a
>>>>>> look at the usage data we've been tracking for JBDS. It really
>>>>>> helped
>>>>>> get
>>>>>> some baseline numbers for ESB usage so we could justify
>>>>>> deprecation
>>>>>> of the
>>>>>> older tooling going forward (still supporting, just not actively
>>>>>> updating,
>>>>>> which is how it's been for a few years now anyway).
>>>>>>
>>>>>> Now we'd like to hook SwitchYard and Fuse Tools wizards and
>>>>>> editors
>>>>>> up to
>>>>>> get them into the tracking data as well.
>>>>>>
>>>>>> Wizards should already be there as long as SY and Fuse depend on
>>>>>> the
>>>>>> usage
>>>>>> plugin.
>>>>>>
>>>>>> For editors you will need to send specific events.
>>>>>>
>>>>>> Do we have anything written up on how to use the frameworks for
>>>>>> the
>>>>>> usage
>>>>>>
>>>>>> tooling in JBDS? Or can you point me at some examples of how
>>>>>> you've
>>>>>> done
>>>>>> it
>>>>>> for wizards and editors in the main JBoss Tools code?
>>>>>>
>>>>>> Docs:
>>>>>>
>>>>>> https://github.com/jbosstools/jbosstools-devdoc/blob/master/api/u
>>>>>> sage/usage_api.adoc
>>>>>>
>>>>>> Please be aware to not send a ping for every little thing - we
>>>>>> don't
>>>>>> want
>>>>>> to overload with data.
>>>>>>
>>>>>> But for example if you want to count the number of times the fuse
>>>>>> editor
>>>>>> is opened you can do that with a daily event counter.
>>>>>>
>>>>>> To find examples - search for .countEvent() in JBoss Tools Server
>>>>>> and
>>>>>> I
>>>>>> think Forge has some too.
>>>>>>
>>>>>> /max
>>>>>> http://about.me/maxandersen
>>>>>>
>>>>>> /max
>>>>>> http://about.me/maxandersen
>>>>>>
>>>> /max
>>>> http://about.me/maxandersen
>>>>
>>>> _______________________________________________
>>>> jbosstools-dev mailing list
>>>> jbosstools-dev at lists.jboss.org
>>>> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>>>
>>> _______________________________________________
>>> jbosstools-dev mailing list
>>> jbosstools-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>>
>> _______________________________________________
>> jbosstools-dev mailing list
>> jbosstools-dev at lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/jbosstools-dev
>>
> _______________________________________________
> jbosstools-dev mailing list
> jbosstools-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/jbosstools-dev


/max
http://about.me/maxandersen
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/jbosstools-dev/attachments/20160312/46e86409/attachment.html

More information about the jbosstools-dev mailing list