Uploaded image for project: 'Puppet Development Kit'
  1. Puppet Development Kit
  2. PDK-1588

Improve analytics granularity for `pdk bundle` invocations

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Normal
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: PDK 1.16.0
    • Component/s: None
    • Labels:
      None
    • Template:
    • Acceptance Criteria:
      • pdk analytics includes more granularity and specificity about what users are doing with `pdk bundle`
    • Team:
      Puppet Developer Experience
    • Release Notes:
      Enhancement
    • Release Notes Summary:
      Hide
      Analytics for `pdk bundle` executions has been updated so that it now includes more detailed (but still not identifying) usage information. The bundler subcommand being executed is now included in the analytics data, for example instead of `pdk bundle install` and `pdk bundle show puppet` both being reported as "bundle" events, they will now be reported as "bundle_install" and "bundle_show" events respectively.

      Additionally, "pdk bundle exec" executions will report the name of the command being executed, so instead of `pdk bundle exec rake spec` reporting a "bundle" event it will now report a "bundle_exec_rake" event.

      This will need to be updated in our analytics documentation in addition to the changelog.
      Show
      Analytics for `pdk bundle` executions has been updated so that it now includes more detailed (but still not identifying) usage information. The bundler subcommand being executed is now included in the analytics data, for example instead of `pdk bundle install` and `pdk bundle show puppet` both being reported as "bundle" events, they will now be reported as "bundle_install" and "bundle_show" events respectively. Additionally, "pdk bundle exec" executions will report the name of the command being executed, so instead of `pdk bundle exec rake spec` reporting a "bundle" event it will now report a "bundle_exec_rake" event. This will need to be updated in our analytics documentation in addition to the changelog.
    • QA Risk Assessment:
      Needs Assessment

      Description

      Currently we redact everything after `pdk bundle` when capturing CLI analytics data, so all we really know is that people run `pdk bundle <something>` quite a bit. In order to make this data more useful for feature planning, we should add a whitelist of subcommands to `pdk bundle` that are safe to capture with analytics and start shipping that additional data.

      For example, all the direct bundler subcommands should be positionally whitelisted. Additionally, we should whitelist common gem invocations that might be happening under `bundle exec`, such as `rspec`, `rake`, etc.

        Attachments

          Activity

            People

            Assignee:
            tim.sharpe Tim Sharpe
            Reporter:
            jesse Jesse Scott
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Zendesk Support