Introduce `Timestamps` Option via mgmt.sock #4970

yophilav · 2021-05-10T20:23:09Z

Allow Management socket to accept timestamps option to be pass through docker socket API.
Update the documents for the latest API version
The latest API is being manually added since there is a gigantic out-of-sync between the template interface managementVersion_2020_07_07.yaml and /edgelet/management generated code.

dmolokanov

is this something that is auto-generated?

arsing

iotedge/edgelet/api/managementVersion_2020_07_07.yaml

Lines 282 to 303 in 6c4269a

    
           parameters: 
        
             - $ref: '#/parameters/api-version' 
        
             - in: path 
        
               name: name 
        
               description: The name of the module to obtain logs for. (urlencoded) 
        
               required: true 
        
               type: string 
        
             - in: query 
        
               name: follow 
        
               description: Return the logs as a stream. 
        
               type: boolean 
        
               default: false 
        
             - in: query 
        
               name: tail 
        
               description: Only return this number of lines from the end of the logs. 
        
               type: string 
        
               default: "all" 
        
             - in: query 
        
               name: since 
        
               description: Only return logs since this time, as a duration (1 day, 1d, 90m, 2 days 3 hours 2 minutes), rfc3339 timestamp, or UNIX timestamp. 
        
               type: string 
        
               default: "0"

and https://github.com/Azure/iotedge/tree/6c4269a0bc7640e22aa60461c2109fbf96f95ef3/edgelet/management need to be updated.

lfitchett · 2021-05-13T05:27:25Z

@gordonwang0 FYI for tokio update since this has mgmt api changes

- Allow Management socket to accept `timestamps` option to be pass through docker socket API. - Update the documents for the latest API version - The latest API is being manually added since there is a gigantic out-of-sync between the template interface `managementVersion_2020_07_07.yaml` and `/edgelet/management` generated code.

…#4981) Context: It generates the attached file, if a module does not use the prescribed logging format (which most module do not), the timestamp is 0. This makes the logs not very useful. The timestamp irrespective of logging format is actually available from Docker log API. Solution: This PR issues `timestamps` from edgeAgent via mgmt.sock to prepending the returning log with timestamp. edgeAgent then parse the timestamp & return the value in json format to portal. Note: This feature requires #4970

- Allow Management socket to accept `timestamps` option to be pass through docker socket API. - Update the documents for the latest API version - The latest API is being manually added since there is a gigantic out-of-sync between the template interface `managementVersion_2020_07_07.yaml` and `/edgelet/management` generated code.

…Azure#4981) Context: It generates the attached file, if a module does not use the prescribed logging format (which most module do not), the timestamp is 0. This makes the logs not very useful. The timestamp irrespective of logging format is actually available from Docker log API. Solution: This PR issues `timestamps` from edgeAgent via mgmt.sock to prepending the returning log with timestamp. edgeAgent then parse the timestamp & return the value in json format to portal. Note: This feature requires Azure#4970

…4981) (#5167) Context: It generates the attached file, if a module does not use the prescribed logging format (which most module do not), the timestamp is 0. This makes the logs not very useful. The timestamp irrespective of logging format is actually available from Docker log API. Solution: This PR issues `timestamps` from edgeAgent via mgmt.sock to prepending the returning log with timestamp. edgeAgent then parse the timestamp & return the value in json format to portal. Note: This feature requires #4970

- Allow Management socket to accept `timestamps` option to be pass through docker socket API. - Update the documents for the latest API version - The latest API is being manually added since there is a gigantic out-of-sync between the template interface `managementVersion_2020_07_07.yaml` and `/edgelet/management` generated code.

…zure#4981) (Azure#5167) Context: It generates the attached file, if a module does not use the prescribed logging format (which most module do not), the timestamp is 0. This makes the logs not very useful. The timestamp irrespective of logging format is actually available from Docker log API. Solution: This PR issues `timestamps` from edgeAgent via mgmt.sock to prepending the returning log with timestamp. edgeAgent then parse the timestamp & return the value in json format to portal. Note: This feature requires Azure#4970

- Allow Management socket to accept `timestamps` option to be pass through docker socket API. - Update the documents for the latest API version - The latest API is being manually added since there is a gigantic out-of-sync between the template interface `managementVersion_2020_07_07.yaml` and `/edgelet/management` generated code.

…zure#4981) (Azure#5167) Context: It generates the attached file, if a module does not use the prescribed logging format (which most module do not), the timestamp is 0. This makes the logs not very useful. The timestamp irrespective of logging format is actually available from Docker log API. Solution: This PR issues `timestamps` from edgeAgent via mgmt.sock to prepending the returning log with timestamp. edgeAgent then parse the timestamp & return the value in json format to portal. Note: This feature requires Azure#4970

- Allow Management socket to accept `timestamps` option to be pass through docker socket API. - Update the documents for the latest API version - The latest API is being manually added since there is a gigantic out-of-sync between the template interface `managementVersion_2020_07_07.yaml` and `/edgelet/management` generated code.

…zure#4981) (Azure#5167) Context: It generates the attached file, if a module does not use the prescribed logging format (which most module do not), the timestamp is 0. This makes the logs not very useful. The timestamp irrespective of logging format is actually available from Docker log API. Solution: This PR issues `timestamps` from edgeAgent via mgmt.sock to prepending the returning log with timestamp. edgeAgent then parse the timestamp & return the value in json format to portal. Note: This feature requires Azure#4970

- Allow Management socket to accept `timestamps` option to be pass through docker socket API. - Update the documents for the latest API version - The latest API is being manually added since there is a gigantic out-of-sync between the template interface `managementVersion_2020_07_07.yaml` and `/edgelet/management` generated code.

Introduce Timestamps

837c0e3

yophilav requested review from arsing and dmolokanov May 10, 2021 20:23

dmolokanov previously approved these changes May 10, 2021

View reviewed changes

arsing requested changes May 10, 2021

View reviewed changes

Update doc & yaml file

313f27a

yophilav dismissed dmolokanov’s stale review via 313f27a May 10, 2021 21:47

yophilav and others added 4 commits May 11, 2021 14:22

Add new yaml template for mgmt.sock api

3a663dc

Update Readme

c3074d2

Update docs

2054d99

Bump the version in yaml

12eb9f9

yophilav requested a review from arsing May 12, 2021 01:47

Merge branch 'release/1.2' into yophilav/GetModuleLogsIssue4_rust_1.2

144560e

yophilav requested a review from gordonwang0 May 12, 2021 01:59

yophilav mentioned this pull request May 13, 2021

Use Docker Timestamp When Log Timestamp is not Available in JSON log. #4981

Merged

arsing requested a review from lfitchett May 13, 2021 03:11

arsing approved these changes May 13, 2021

View reviewed changes

gordonwang0 approved these changes May 13, 2021

View reviewed changes

yophilav added the ready-to-merge label May 14, 2021

kodiakhq bot merged commit 37c661b into Azure:release/1.2 May 14, 2021

yophilav mentioned this pull request Jun 25, 2021

Use Docker Timestamp When Log Timestamp is not Available in JSON log (#4981) #5167

Merged

yophilav mentioned this pull request Jun 25, 2021

Use Docker Timestamp When Log Timestamp is not Available in JSON log. #5173

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce `Timestamps` Option via mgmt.sock #4970

Introduce `Timestamps` Option via mgmt.sock #4970

yophilav commented May 10, 2021 •

edited

Loading

dmolokanov left a comment

arsing left a comment

lfitchett commented May 13, 2021

	parameters:
	- $ref: '#/parameters/api-version'
	- in: path
	name: name
	description: The name of the module to obtain logs for. (urlencoded)
	required: true
	type: string
	- in: query
	name: follow
	description: Return the logs as a stream.
	type: boolean
	default: false
	- in: query
	name: tail
	description: Only return this number of lines from the end of the logs.
	type: string
	default: "all"
	- in: query
	name: since
	description: Only return logs since this time, as a duration (1 day, 1d, 90m, 2 days 3 hours 2 minutes), rfc3339 timestamp, or UNIX timestamp.
	type: string
	default: "0"

Introduce Timestamps Option via mgmt.sock #4970

Introduce Timestamps Option via mgmt.sock #4970

Conversation

yophilav commented May 10, 2021 • edited Loading

dmolokanov left a comment

Choose a reason for hiding this comment

arsing left a comment

Choose a reason for hiding this comment

lfitchett commented May 13, 2021

Introduce `Timestamps` Option via mgmt.sock #4970

Introduce `Timestamps` Option via mgmt.sock #4970

yophilav commented May 10, 2021 •

edited

Loading