search

OpenFn / lightning

OpenFn/Lightning ⚡️ is the newest version of the OpenFn DPG and provides a web UI to visually manage complex workflow automation projects.
https://openfn.github.io/lightning/
GNU Lesser General Public License v3.0
115 stars 31 forks source link

More information about anonymous public metrics #2203

Closed taylordowns2000 closed 1 week ago

taylordowns2000 commented 1 week ago

I'd like to start making some more noise about the anonymous public metrics system. It's looking really good and we've already got a number of instances around the world reporting. This PR introduces a notice that explains why it's so important for the project and provides instructions for seeing the anonymous, public, aggregate data as well as how to turn participation on or off.

Two questions:

  1. Technical: Is it OK to use Logger in runtime.exs?
  2. Communications: Do you like the language here? Anything we should add or remove?

The notices themselves:

If enabled (default)

12:35:23.502 [notice] ❤️ Thank you for participating in anonymous public impact tracking!

OpenFn is a free and open-source Digital Public Good. Even if you are unable to contribute to the movement financially or by participating in our product development community, sending these anonymous aggregate usage reports will help us ensure the long-term sustainability of the project by better demonstrating our impact and helping us secure further donor support.

View the aggregated anonymous public metrics submitted by other OpenFn instance administrators like you from around the world here: https://analytics.openfn.org/public/dashboard/d4d7766e-e2fe-4673-b4e5-8bf52f0054a1

_You are reporting to https://impact.openfn.org. If you would like to opt-out of anonymous public impact reporting, you can set your USAGE_TRACKING_ENABLED environment variable to false at any time._

If disabled

12:35:15.138 [notice] You have opted-out of anonymous public impact tracking.

OpenFn is a free and open-source Digital Public Good. Even if you are unable to contribute to the movement financially or by participating in our product development community, sending these anonymous aggregate usage reports will help us ensure the long-term sustainability of the project by better demonstrating our impact and helping us secure further donor support.

View the aggregated anonymous public metrics submitted by other OpenFn instance administrators like you from around the world here: https://analytics.openfn.org/public/dashboard/d4d7766e-e2fe-4673-b4e5-8bf52f0054a1

_If the product is benefitting you or your organization, we hope you will consider opting-in to anonymous public impact tracking in the future. You can do so by setting your USAGE_TRACKING_ENABLED environment variable to true at any time._

codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 82.35294% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.68%. Comparing base (104aae8) to head (3ba0ca6).

Files Patch % Lines
lib/lightning/application.ex 75.00% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #2203 +/- ## ========================================== - Coverage 89.70% 89.68% -0.02% ========================================== Files 275 275 Lines 9039 9055 +16 ========================================== + Hits 8108 8121 +13 - Misses 931 934 +3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

rorymckinley commented 1 week ago

@taylordowns2000 This looks very cool!

2 questions (asked in ignorance):

1) I know that on my local development, a lot of information gets pushed to the logs. So much so, that I may miss the notice being output to it. Would there be a way to add this information someplace else as well, e.g. visible in the UI, or perhaps as a banner if you run an IEx session? 2) TIL about Application.start_phase/3 (thanks @jyeshe !) - could that be used as an alternative way to trigger these messages, rather than generating them from runtime.ex?

christad92 commented 1 week ago

@taylordowns2000 I like this.

I am recommending a subtle change in the message. Please see below:

DEFAULT Thank you for participating in anonymous public impact reporting!

OpenFn is a free and open-source Digital Public Good used by organizations and governments worldwide to deliver and scale impact projects to people across communities.

We collect anonymous public impact data from various deployments of our Open Source platform to help us understand the needs of our users and better demonstrate our impact around the world.

As an open source project, we rely on contributions from our community of users to grow and continue releasing new features. Asides from contributing financially or by participating in our product development community, anonymous impact reporting is also a great way to contribute to the project because these reports ensure the long term sustainability of the project by allowing us to secure further donor support.

View the aggregated anonymous public metrics submitted by other OpenFn instance administrators like you from around the world here: https://analytics.openfn.org/public/dashboard/d4d7766e-e2fe-4673-b4e5-8bf52f0054a1

Your reports will be sent to https://impact.openfn.org. If you would like to opt-out of anonymous public impact reporting, you can set your USAGE_TRACKING_ENABLED environment variable to false at any time.

IF DISABLED

OpenFn is a free and open-source Digital Public Good used by organizations and governments worldwide to deliver and scale impact projects to people across communities globally.

Sharing anonymized usage and impact metrics to our global impact dashboard is another you can contribute to us beyond financial contribution and participating in our product development community.

These reports help us ensure long-term sustainability of this project by better demonstrating our impact and helping us secure further donor support.

View the aggregated anonymous public metrics submitted by other OpenFn instance administrators like you from around the world here: https://analytics.openfn.org/public/dashboard/d4d7766e-e2fe-4673-b4e5-8bf52f0054a1

We encourage you to consider opting in for anonymous public impact reporting. If you would like to do so now, please set your USAGE_TRACKING_ENABLED environment variable to TRUE.

At some point in the future, I'd love for us to have a way for super users to toggle this on/off from their admin dashboard.

taylordowns2000 commented 1 week ago

@christad92 , hard for me to see proposed changes so i'm gonna go with my language. happy to discuss over a google doc with tracked changes later!