Skip to content

1-Click Log Exporter

Created by: ryphil

Problem to solve

Ensure Admins have a simple, efficient way to export all logs associated with Sourcegraph to aid debugging

Measure of success

  • feature is used by 70% of customers to provide initial data about their Sourcegraph instance when the customer issue is created during a 1 month span (assuming they're on the latest release)
  • feature is used by 50% of customers to provide additional data during the process of resolving an already existent customer issue during a 1 month span (assuming they're on the latest release)
  • CE handbook process update to include exporting information as the first step in debugging process and training provided to CE on how to use new export functionality
  • <10% of customers decline usage of export functionality

Solution summary

  • create a mechanism to conveniently export all necessary data about Sourcegraph instance
  • make this mechanism generic and extensible so that every team can add their things which will also be exported
  • make this mechanism a go-to for creating and providing initial data in customer issues
  • make the interface as straightforward, easy to use and uncluttered as possible (a set of checkboxes with (de)select all option and an export button)
  • provide some customisation level when accessing the export API directly (limiting DB query outputs, tailing log lines, selecting logging level, etc.)

Artifacts:

  • TO DO

Delivery plan

All details linked here.

/cc @jplahn @ryphil