Skip to content

Add design document for network statistics. #8743

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

Merged
merged 1 commit into from
Nov 22, 2018

Conversation

SeppoTakalo
Copy link
Contributor

Description

Add design document for network statistics.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[X] Docs update
[ ] Test update
[ ] Breaking change

@SeppoTakalo
Copy link
Contributor Author

Submitting design documents that have been reviewed and discussed in internal email chain.

For @deepikabhavnani and @SenRamakri and @lauri-piikivi to review if I missed any details.

@SeppoTakalo
Copy link
Contributor Author

This is just .md document, so no need for CI checks other than what launches automatically.

@cmonr cmonr requested a review from a team November 14, 2018 15:22
@deepikabhavnani
Copy link

@AnotherButler - Please review

deepikabhavnani pushed a commit to deepikabhavnani/mbed-os that referenced this pull request Nov 15, 2018
SocketStats Class is added to collect and provide the statistics information.
In this phase only socket information is collected and max sockets that can
be recorded at any time are configurable through 'MBED_CONF_NSAPI_SOCKET_STATS_MAX_COUNT'

Network statistics can be enabled through a macro MBED_NW_STATS_ENABLED

More information on design is captured in ARMmbed#8743
@0xc0170 0xc0170 requested a review from melwee01 November 16, 2018 09:49
@0xc0170
Copy link
Contributor

0xc0170 commented Nov 16, 2018

@AnotherButler - Please review

@melwee01 Can you review ?


```
typedef struct {
uint32_t tick; /**< osKernelGetTick() value of when event happened, or equivalent timestamp */
Copy link
Contributor

Choose a reason for hiding this comment

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

should this be 64bit timestamp (Kernel::get_ms_count()) or sufficient having 32 bit?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"or equivalent"

;)

So the implementation can do this correctly by using uint64_t as that is what Mbed OS API gives.

@melwee01
Copy link
Contributor

If this is for external use, then what kind of delivery are we talking about?

@deepikabhavnani
Copy link

deepikabhavnani commented Nov 20, 2018

If this is for external use, then what kind of delivery are we talking about?

Didn't get that query.

@melwee01
Copy link
Contributor

Is this for the Mbed OS docs site? If so, it needs not just some formatting changes but a full rewrite to be in accordance with the external docs standards.

@deepikabhavnani
Copy link

Is this for the Mbed OS docs site?

No these are internal design docs which stay in mbed-os repo.

@0xc0170 0xc0170 merged commit 02266db into ARMmbed:master Nov 22, 2018
deepikabhavnani pushed a commit to deepikabhavnani/mbed-os that referenced this pull request Nov 26, 2018
SocketStats Class is added to collect and provide the statistics information.
In this phase only socket information is collected and max sockets that can
be recorded at any time are configurable through 'MBED_CONF_NSAPI_SOCKET_STATS_MAX_COUNT'

Network statistics can be enabled through a macro MBED_NW_STATS_ENABLED

More information on design is captured in ARMmbed#8743
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants