Environment information

TypeScript Autometrics
===
VSCode Info
Version: 1.80.2
Commit: 2ccd690cbff1569e4a83d7c43d45101f817401dc
Date: 2023-07-27T20:57:59.134Z
Electron: 22.3.14
ElectronBuildId: 22695494
Chromium: 108.0.5359.215
Node.js: 16.17.1
V8: 10.8.168.25-electron.0
OS: Darwin arm64 22.6.0

What happened?

Project:

.
├── dist
│  ├── routes.js
│  ├── routes.js.map
│  ├── server.js
│  ├── server.js.map
│  ├── util.js
│  └── util.js.map
├── package-lock.json
├── package.json
├── README.md
├── rome.json
├── src
│  ├── routes.ts
│  ├── server.ts
│  └── util.ts
└── tsconfig.json

Repro:

1. Set the graph preferences to Autometrics Explorer
2. In server.ts when hovering over an Autometrics instrumented function VSCode generates a tooltip with the following link: http://localhost:6789/explorer/#/functions/details/handleGetAllUsers/requestRate

Expected result

This is the correct link it should generate, however:

http://localhost:6789/explorer/#/functions/details/m/%2Fdist%2Fserver.js/handleGetAllUsers

Note the dist in the module name missing.

In my mind there are two options:

1. Either the extension needs to correctly figure out the module name (might be hard in different languages)
2. Autometrics Explorer should handle links with just the function names: redirect to the complete URL with the module name or if there are multiple functions with the same names in different modules - show an intermediary selector screen

To reproduce:

• Open the Autometrics side bar
• Click on one of your functions listed in the sidebar
• A new tab should open in your editor with the request rate graph
• No other graphs are present

The issue seems to stem from this line, which calls "Open chart" with an argument of type "function". However, if you change the type to "function_graphs", then the page will not refresh when you click between functions

Environment information

VS-Code autometrics 0.5.0 inside VSCode Version: 1.82.0 (Universal)

Specifically, looking at a typescript file

What happened?

I added a docstring to a function that was wrapped by autometrics. When I hovered over the function, the docstring I added had been added many, many times to the tooltip.

Expected result

I would expect existing docstrings to be preserved, and not repeated tens of times.

The extension should support using basic auth to authenticate with Prometheus. We may also want to support other auth mechanisms to talk to other hosted Prometheus-compatible solutions

If we support multiple environments (#26), we should also think about how to have the auth details on a per-environment basis.

Let's get Go support in the extension as well.

Environment information

Autometrics Python v0.5, using VSCode on macOS

What happened?

1. Decorate an async function in python file
2. Hover over that async function
3. No autometrics tooltip appears!

Expected result

Autometrics tooltip should appear for decorated async functions in python

With #10, the foundation is being laid for implementing graphs inside the VS Code extension. This is a tracking issue for progress. Also feel free to leave ideas and suggestions related to graphs here.

• Create a TS library for rendering graphs. This will be based on the charts in our Studio product and open-sourced in the fiberplane repository. Done: fiberplane/fiberplane#48
• Basic integration of the graph library into our extension. Done: #22
• Update the design, making sure VS Code themes work well
  • add toggle for showing/hiding promql
  • add additional queries for called by metrics
  • add timerange selector/controls
  • make top bar sticky
  • fix resize issue where graphs don't shrink when window is resized
  • charts:
    • use vscode theme colors
    • x-axis should better respect the width (sometimes the tick text overlaps)
  • promql code block:
    • add copy button

Our Autometrics tooltips contain queries. Currently, those point to external URLs, but when we have charts inside the extension, we want to open them right there for a consistent experience.

One complicating factor is that different languages have different mechanisms for opening tooltips. Some rely on the extension itself, which is likely easier to intercept, but for instance Autometrics-rs generates Rustdoc strings, which we may need to detect somehow.

Charts should consistently open within the extension, regardless of language.

Environment information

VSCode on macOS

What happened?

I received intermittent toast notifications of errors, and they suggested they were coming from the Autometrics extension.

When I investigated, it turns out they were coming from a tailwind intellisense extension, which had some sort of typescript incompatibility.

Expected result

I would not expect Autometrics to show errors that are due to other extensions. I thought that Autometrics was the culprit, but it was not

This requires autometrics-dev/am#40 to be completed.

However it would be great when a project has an am.toml file that vscode would suggest to install this extension. Ideally the extension would also parse/use the relevant values provided in this config file.

After I installed the language server plugin and added it to my tsconfig, I still did not see any links in the tooltips for autometrics functions. (I double checked that I was using the project's locally installed typescript.)

I restarted the language server, but that still didn't work. I had to disable/enable the Autometrics VSCode extension before links would appear in the popovers.

Filing this issue in case it is something that other people run into

Before we have a believable beta we should at least support our flagship language: Rust

This is currently blocked by #29.

Finalizing this is also blocked by autometrics-dev/autometrics-rs#80, although we shouldn't have to wait with the implementation. Until the environment variable is supported, we would just have 2 doc tooltips which would be confusing.

See autometrics-dev/autometrics-shared#74

We should make sure that if Prometheus isn't configured yet or correctly, that we give some proper feedback to the user. Most likely we want to opt for a toast-like notification, which are built into VS Code. Clicking it should open the settings page.

Right now the extensions supports:

• using its builtin graphs
• linking out to prometheus

But it would be good to add another option and that is to link to the am cli's explorer.

What needs to be done for this?

• Add an option to the graph preferences option:

We need some kind of a welcome screen for the extension, something that can show aggregates such as response times over all functions that are autometricized. Other ideas welcome :)

To configure the prometheus url for my extension I needed to first open the extension, click the gear icon, and then manually edit the prometheus URL.

It would be nice to be able to use the command menu to open the config page, as other extensions do:

When the graphs are implemented, we also want to offer functionality to export a chart as a cell to a Fiberplane Notebook.

For now, this is blocked by #12

ability to leave feedback or create a GitHub issue from within the extension

All queries should be updated in the following way:

• Any references to the function call counter should be identified using {__name__=~"function_calls(_count)?(_total)?"}
• Any references to the histogram should be identified using {__name__=~"function_calls_duration(_seconds)?_bucket"} or _count/_sum

Currently the Python implementation uses a regular expression to detect Autometrics annotations. In order to implement Rust support, this approach would not be sufficient, since Rust can annotate entire impl blocks with a single annotation, which would be too complex to parse with a regex.

To solve this, we need to implement a proper parsing solution in the extension. Something like Tree-sitter might be an option, since it supports all the languages we want to support as well, but other options may be fine too.

The new Autometrics sidebar does function discovery by issuing an instant query for the function_calls_count metric and looking at the labels of the metrics coming back. Unfortunately, Prometheus only seems to return metrics for labels that have been recently used, so that functions that don't get used often/recently don't come back.

Related issue: prometheus/prometheus#11181