[Essentials] Error Telemetry Server API JEP Draft

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

[Essentials] Error Telemetry Server API JEP Draft

Baptiste MATHUS-3
Hello everyone,

After defining how we would do the client side of error telemetry logging in JEP-304, I just published a draft of the corresponding server side for review:



Feedback welcome. You will notice it's simpler and smaller than the client side one.

As usual, after I made sure there are no clear pushback from the community here, I will file the corresponding PR to get it merged and assigned a JEP number.

Thank you everyone!

-- Baptiste

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS5GKE7%2BFqVOgqGG%3D03Mvd2ZJFZQS%2BHUmMeP_sAsRVEmoA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Essentials] Error Telemetry Server API JEP Draft

R. Tyler Croy
(replies inline)

On Tue, 08 May 2018, Baptiste Mathus wrote:

> Hello everyone,
>
> After defining how we would do the client side of error telemetry logging
> in JEP-304 <https://github.com/jenkinsci/jep/tree/master/jep/304>, I just
> published a draft of the corresponding server side for review:
>
> https://github.com/batmat/jep/tree/JENKINS-51140/0000


Woohoo more designs! :)

I have a lot of questions and feedback, and since this is an early stage
design, I thiink it would be more efficient for us to jump on a Google Hangout
tomorrow (Friday).

The biggest gap which I'm sure you've thought about but isn't present in this
design document are the client/server interactions and what are the expected
REST calls/responses. Take a look at this for more of what I'm expecting:
    https://github.com/jenkinsci/jep/tree/master/jep/303#specification


Cheers

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/20180510225420.GG2935%40grape.lasagna.io.
For more options, visit https://groups.google.com/d/optout.

signature.asc (201 bytes) Download Attachment
Reply | Threaded
Open this post in threaded view
|

Re: [Essentials] Error Telemetry Server API JEP Draft

Baptiste MATHUS
Thanks for the feedback!

Indeed, I had in mind the usual HTTP 201 for creation, and so on for other cases, but definitely this needed to be not just in my mind. That's the whole point.
Also, your challenge here made me rethink and refactor the prototype to avoid sending back the log as it's usually done in REST endpoints, because it seems like a waste when for instance client would be sending 5000 characters or more to just have them transiting back and forth for nothing.

About the authentication/registration, I clarified the intent is to make this endpoint /behind/ what's defined in JEP 303.

Yes, let's meet when you're available, I think that's a good idea. I'm especially interested to hear if you have an opinion about what the response payload should have. 
For instance, as I wrote in a comment in the JEP:

"Should we compute a hash or something to be able to uniquely reference/find a log in the system between client and server if needed?"

-- Baptiste

Le ven. 11 mai 2018 à 00:54, R. Tyler Croy <[hidden email]> a écrit :
(replies inline)

On Tue, 08 May 2018, Baptiste Mathus wrote:

> Hello everyone,
>
> After defining how we would do the client side of error telemetry logging
> in JEP-304 <https://github.com/jenkinsci/jep/tree/master/jep/304>, I just
> published a draft of the corresponding server side for review:
>
> https://github.com/batmat/jep/tree/JENKINS-51140/0000


Woohoo more designs! :)

I have a lot of questions and feedback, and since this is an early stage
design, I thiink it would be more efficient for us to jump on a Google Hangout
tomorrow (Friday).

The biggest gap which I'm sure you've thought about but isn't present in this
design document are the client/server interactions and what are the expected
REST calls/responses. Take a look at this for more of what I'm expecting:
    https://github.com/jenkinsci/jep/tree/master/jep/303#specification


Cheers

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/20180510225420.GG2935%40grape.lasagna.io.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS5XFYrY5b6KEDg9ZSGHd5BmSympOjArmNNxEWyuVVMT4Q%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Essentials] Error Telemetry Server API JEP Draft

Baptiste MATHUS
Hello everyone,

For your information, I've now opened a PR to make this proposal a draft.

Cheers!



Le ven. 11 mai 2018 à 14:49, Baptiste Mathus <[hidden email]> a écrit :
Thanks for the feedback!

Indeed, I had in mind the usual HTTP 201 for creation, and so on for other cases, but definitely this needed to be not just in my mind. That's the whole point.
Also, your challenge here made me rethink and refactor the prototype to avoid sending back the log as it's usually done in REST endpoints, because it seems like a waste when for instance client would be sending 5000 characters or more to just have them transiting back and forth for nothing.

About the authentication/registration, I clarified the intent is to make this endpoint /behind/ what's defined in JEP 303.

Yes, let's meet when you're available, I think that's a good idea. I'm especially interested to hear if you have an opinion about what the response payload should have. 
For instance, as I wrote in a comment in the JEP:

"Should we compute a hash or something to be able to uniquely reference/find a log in the system between client and server if needed?"

-- Baptiste

Le ven. 11 mai 2018 à 00:54, R. Tyler Croy <[hidden email]> a écrit :
(replies inline)

On Tue, 08 May 2018, Baptiste Mathus wrote:

> Hello everyone,
>
> After defining how we would do the client side of error telemetry logging
> in JEP-304 <https://github.com/jenkinsci/jep/tree/master/jep/304>, I just
> published a draft of the corresponding server side for review:
>
> https://github.com/batmat/jep/tree/JENKINS-51140/0000


Woohoo more designs! :)

I have a lot of questions and feedback, and since this is an early stage
design, I thiink it would be more efficient for us to jump on a Google Hangout
tomorrow (Friday).

The biggest gap which I'm sure you've thought about but isn't present in this
design document are the client/server interactions and what are the expected
REST calls/responses. Take a look at this for more of what I'm expecting:
    https://github.com/jenkinsci/jep/tree/master/jep/303#specification


Cheers

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/20180510225420.GG2935%40grape.lasagna.io.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/jenkinsci-dev/CANWgJS4GkPFdM9EfgEGNKqgASBpETf%2BxOH6X7VdBtPGtEnN30w%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.