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

New: Add endpoint/data contract to log telemetry to internal api #3830

Merged
merged 3 commits into from Jun 23, 2020

Conversation

utsavized
Copy link
Contributor

Closes #3829

@utsavized utsavized added this to the 2006-2 milestone Jun 16, 2020
@utsavized utsavized requested review from molant and sarvaje June 16, 2020 19:34
@utsavized utsavized requested a review from antross as a code owner June 16, 2020 19:34
@utsavized utsavized self-assigned this Jun 16, 2020
@utsavized utsavized removed the request for review from antross June 17, 2020 17:51
----------------------------------------
Fix #3829
@utsavized
Copy link
Contributor Author

Bump. @sarvaje @molant

Copy link
Member

@molant molant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@utsavized does your other telemetry PR (webhintio/telemetry#190) need to be deployed first?

packages/utils-telemetry/package.json Outdated Show resolved Hide resolved
time: string;
};

const appInsightsEndpoint = 'https://dc.services.visualstudio.com/v2/track';
const telemetryEndPoint = 'https://webhint-telemetry.azurewebsites.net/api/log';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hxlnt just want confirmation this is what we want: to use our Azure Function to report the telemetry to app insights so we can clean up any extra information that we do not want to store.
Is that correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. Also, we may eventually want to redirect a custom subdomain (like webhint.io/telemetry) to this endpoint to make it more official. I talked about that with Tony, but we decided that we can do that as part of another task.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM.

packages/utils-telemetry/src/telemetry-api.ts Show resolved Hide resolved
@utsavized
Copy link
Contributor Author

@utsavized does your other telemetry PR (webhintio/telemetry#190) need to be deployed first?

Yes. Telemetry, then hint, then webhint.io (that PR is coming after these get deployed) :)

@utsavized
Copy link
Contributor Author

@molant Is this good to go?

measurements: Measurements;
name: string;
properties: Properties;
ver?: number;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the version added automatically when sending the telemetry? I know we have a few metrics around this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this tracking webhint version? A bunch of other places (including webhint.io) had this hardcoded to 2, so I thought this was the v2 of the app insights REST API. If you look at Line 84 of this file (before change), you will see if set to 2.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH, I don't know. @antross it he one that took care of the telemetry and now you so probably you know best how it works 😅

Let's get #3837 merged first and then this one, sounds good?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good ... looks like that one is merged now, is this one good to go then?

@molant molant changed the base branch from master to main June 23, 2020 03:14
@molant molant merged commit 90c39dd into main Jun 23, 2020
@molant molant added this to Done in Backlog + current sprint via automation Jun 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

[Feature] Update utils-telemetry package with new endpoint and data contract
3 participants