Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

3.4 plan for Datadog extension #3297

Open
nicksnyder opened this Issue Apr 8, 2019 · 0 comments

Comments

Projects
None yet
2 participants
@nicksnyder
Copy link
Member

nicksnyder commented Apr 8, 2019

The focus for the 3.4 release cycle is to get the Datadog extension working 100% for Python, Go, Node.js, Java.

WIP: https://github.com/sourcegraph/sourcegraph-datadog-metrics

  • Update this checklist with any unfinished work from #3177
  • Rename repo and extension from sourcegraph-datadog-metrics to sourcegraph-datadog
  • Add codecov to sourcegraph-datadog repo
  • Python
    • Datadog extension renders line decorations with "View metric (Datadog) >>" for lines that resemble metrics calls that link to the most relevant page on Datadog.
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
        • 80% test coverage
        • Merge the README PR from the first step. The links should now work.
    • Datadog extension renders line decorations with "Live traces (Datadog) >>" for lines that resemble traces (or are known to define a span) that link to the most relevant page on Datadog
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
  • "(Show/Hide) metrics decorations" action in command palette
    • Implementation done
    • 80% test coverage
    • Update the README to document this.
  • "(Show/Hide) trace decorations" action in command palette
    • Implementation done
    • 80% test coverage
    • Update the README to document this.
  • "(Show/Hide) all decorations" action in command palette and a Datadog icon action item on the editor/title
    • Implementation done
    • 80% test coverage
    • Update the README to document this.
  • If user input is needed to configure the Datadog account (e.g., needing the account ID to construct the URLs), a progressive flow to complete setup:
    • Line decorations are still shown with a dimmer color and read "Missing Datadog (whatever)" (see LightStep example)
    • An editor/title action to "Set Datadog (whatever)" is shown that prompts the user for the value
  • Go
    • Datadog extension renders line decorations with "View metric (Datadog) >>" for lines that resemble metrics calls that link to the most relevant page on Datadog.
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
        • 80% test coverage
        • Merge the README PR from the first step. The links should now work.
    • Datadog extension renders line decorations with "Live traces (Datadog) >>" for lines that resemble traces (or are known to define a span) that link to the most relevant page on Datadog
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
  • Node.js (TypeScript/JavaScript)
    • Datadog extension renders line decorations with "View metric (Datadog) >>" for lines that resemble metrics calls that link to the most relevant page on Datadog.
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
        • 80% test coverage
        • Merge the README PR from the first step. The links should now work.
    • Datadog extension renders line decorations with "Live traces (Datadog) >>" for lines that resemble traces (or are known to define a span) that link to the most relevant page on Datadog
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
  • Java
    • Datadog extension renders line decorations with "View metric (Datadog) >>" for lines that resemble metrics calls that link to the most relevant page on Datadog.
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
        • 80% test coverage
        • Merge the README PR from the first step. The links should now work.
    • Datadog extension renders line decorations with "Live traces (Datadog) >>" for lines that resemble traces (or are known to define a span) that link to the most relevant page on Datadog
      • Create (but don't merge) a PR to update the README to include example links where this extension will work for this language.
        • Link to Sourcegraph.com file/line where decoration should appear
        • Link to GitHub.com file/line where decoration should appear
        • Link to GitHub.com PR diff file/line where decoration should appear
      • Implement line decorations that can be detected by looking at the single line; i.e., simply without needing to parse/analyze multiple lines or multiple files.
  • The README.md file and other information shown on the extension's registry page (e.g., https://sourcegraph.com/extensions/sourcegraph/sentry) is informative and up to date with respect to:
    • Features
    • Usage instructions
    • Compatibility (which versions of Sourcegraph, which code hosts, and which forms of the external service (e.g., Datadog's US endpoint vs. Datadog's EU endpoint))
  • If the extension is mentioned on the Datadog's website, that material is also kept up to date with what we have on our own site.

Customers (not exhaustive):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.