-
Notifications
You must be signed in to change notification settings - Fork 41
Start text on formatting names for logs #1355
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -324,6 +324,32 @@ Reason Phrase { | |
| such as language tags, that would aid comprehension by any entity other than | ||
| the one that created the text. | ||
|
|
||
| ## Representing Namespace and Track Names | ||
|
|
||
| There is often the need to render namespace tuples and track names in | ||
| logs or other places. The namespace and track name are binary so they | ||
| need to be converted to a safe form for logging. Having a common way to | ||
| do this is particularly useful for tools that monitory security | ||
| incidents across relays from different vendors. The following format is | ||
| RECOMMONDED: | ||
|
|
||
| * Each of the namespace tuples are rendered in order with a period | ||
| between them followed by the track name with a minus between the last | ||
afrind marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| namespace and track name. | ||
|
|
||
| * Bytes in the range a-z, A-Z, and 0-9 are are output as is while bytes | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This seems overly restrictive, as there are plenty of printable ASCII chars. I noticed @suhasHere uses full track names like this ( 000001/app=01/conf=000003/media=C1[h264,width=1920,height=1080,fps=30 Is there a reason to forbid symbols like I do think it's imperative we escape the tuple and namespace/name separators that appear in the names.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we can change the way the draft says us to :-) Might be a good reason for this PR
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. AI says:
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's escape whitespace.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Keep in mind that if we want to align with files draft which I think is good idea, then we need to restrict to the file safe set. This use . which is not always file safe but it should not have a name that ends up starting with .
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I probably need to go read the files draft, and think about how it uses full-track names encoded as strings. Note that if your first namespace tuple is empty (0 length, which we don't prohibit, I think?), you will get one starting with a dot. |
||
| all other bytes are percent encoded as a percent symbol followed by | ||
| exactly two lower case hex digits. | ||
|
|
||
| For example, if a namespace had two two tuples, the first with the bytes | ||
suhasHere marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 0x48,0x69 , the next with bytes 0xFF, and a track name with the byte | ||
afrind marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 0x30 would render as the string "Hi.%ff-0". The goal of this format is | ||
| to have a format that is both filename and URL safe. It allows many | ||
| common names to be rendered it an easily human readable form while still | ||
| supporting all binary values. | ||
suhasHere marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| TODO - update examples in this draft to match this. | ||
|
|
||
| # Object Data Model {#model} | ||
|
|
||
| MOQT has a hierarchical data model, comprised of tracks which contain | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.