https://projects.osmocom.org/https://projects.osmocom.org/favicon.ico?16647414092016-05-04T14:18:03ZOpen Source Mobile CommunicationsCellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=13202016-05-04T14:18:03Zlaforge
<ul><li><strong>Precedes</strong> <i><a class="issue tracker-2 status-3 priority-2 priority-default closed behind-schedule" href="/issues/1653">Feature #1653</a>: KPIs for OsmoNITB</i> added</li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=13492016-05-09T13:58:23Zmsuraev
<ul><li><strong>Related to</strong> <i><a class="issue tracker-2 status-5 priority-3 priority-high3 closed" href="/issues/1651">Feature #1651</a>: document the control interface(s) of the various programs</i> added</li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=14152016-05-10T11:47:35Zlaforge
<ul><li><strong>Assignee</strong> changed from <i>msuraev</i> to <i>lynxis</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=14172016-05-10T11:55:00Zlaforge
<ul><li><strong>Priority</strong> changed from <i>Normal</i> to <i>High</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=14192016-05-10T14:04:30Zlynxis
<ul></ul><p><strong>how the old counters (statistics.c), the newer ones (rate_ctr.c) and the new stats system (stats.c) work together.<br /></strong><pre>
statistics.c ---> stats.c
rate_ctr.c -|
stat_item.c -| (group description has the same struct, items not)
</pre></p>
<p>I'll create a command to generate asciidoc tables which then included into the documentation.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=14202016-05-10T14:18:40Zlynxis
<ul></ul><p>similiar to the table osmobts-abis.pdf Table 9: Messages compliant with TS 12.21<br /><a class="external" href="http://git.osmocom.org/osmo-gsm-manuals/tree/OsmoBTS/abis/oml.adoc">http://git.osmocom.org/osmo-gsm-manuals/tree/OsmoBTS/abis/oml.adoc</a></p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=14212016-05-10T17:58:23Zlaforge
<ul></ul>to re-cap what was discussed in person today:
<ul>
<li>find a way to programmatically export the rate_ctr and stats_ctr similar in principle to what we do with the vty for generating the vty reference manual</li>
<li>attempt to genrate one asciidoc table per counter group
<ul>
<li>the table should contain a hyperlink to a chapter-anchor which is generate dfrom the counter name in the code</li>
</ul>
</li>
<li>the asciidoc output can then be amended with human-written further details about each of the counters</li>
</ul>
<p>Legacy 'osmo_counter' do not require programmatic export, it should be sufficient to list them manually. Thet should be phased out and will probably be replaced by one of the later counters.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=14972016-06-01T13:58:47Zlaforge
<ul></ul><p><a class="external" href="https://gerrit.osmocom.org/#/c/70">https://gerrit.osmocom.org/#/c/70</a> is the related gerrit patch set</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=23712016-11-09T09:32:06Zlaforge
<ul></ul><p>please resolve the issue if completed, or at least update "% Done" and indicate which parts are missing.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=25352016-12-02T17:33:32Zlaforge
<ul></ul><p>'show asciidoc counters' is working for quite some time. However, I cannot see the output inside the osmocom user manuals yet. I also couldn't find a branch in osmo-gsm-manuals.git which I could merge. Somehow I think this feature existed, but where can I find the code to merge automatic inclusion in the manuals? Lynxis?</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=33272017-03-10T21:30:29Zlaforge
<ul></ul><p>lynxis, any update to my last question 3 months ago?</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=41842017-05-30T15:38:36Zlaforge
<ul></ul><p>yet another follow-up, three months after my last ping that was again three months later? This is not acceptable, sorry.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=65752017-12-05T15:44:08Zlynxis
<ul></ul><ul>
<li>BTS doesn't have any counters.</li>
<li>MGW doesn't have any counters.</li>
<li>GGSN doesn't have any counters.</li>
<li>HLR doesn't even have the required vty command. Missing vty stats init?</li>
</ul>
<ul>
<li>PCU <a href="https://gerrit.osmocom.org/#/c/5193/" class="external">g5193</a></li>
<li>SGSN <a href="https://gerrit.osmocom.org/#/c/5194/" class="external">g5194</a></li>
<li>BSC <a href="https://gerrit.osmocom.org/#/c/5191/" class="external">g5191</a></li>
<li>MSC <a href="https://gerrit.osmocom.org/#/c/5192/" class="external">g5192</a></li>
</ul>
<ul>
<li>libosmocore: remove empty osmo counters table<br /> - <a href="https://gerrit.osmocom.org/#/c/5189/" class="external">g5189</a><br /> - <a href="https://gerrit.osmocom.org/#/c/5190/" class="external">g5190</a></li>
</ul>
<p><a class="user active" href="https://projects.osmocom.org/users/7">laforge</a>: I've dropped the NITB part. Is this ok?</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=65762017-12-05T15:44:17Zlynxis
<ul><li><strong>% Done</strong> changed from <i>0</i> to <i>80</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=65772017-12-05T15:44:25Zlynxis
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>In Progress</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=65782017-12-05T16:00:00Zlynxis
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Feedback</i></li></ul><p>waiting for the git review</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=66952017-12-10T20:06:44Zlaforge
<ul><li><strong>Project</strong> changed from <i>OsmoNITB</i> to <i>Cellular Network Infrastructure</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=82972018-03-16T19:56:24Zlaforge
<ul><li><strong>Assignee</strong> changed from <i>lynxis</i> to <i>daniel</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=93632018-05-17T11:32:58Zlaforge
<ul></ul><p>let's try to get this to conclusion, please</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=104432018-07-25T07:01:52Zdaniel
<ul><li><strong>Blocked by</strong> <i><a class="issue tracker-1 status-1 priority-2 priority-default" href="/issues/3417">Bug #3417</a>: show asciidoc counters does not show all the counters available</i> added</li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=147532019-06-06T15:46:28Zdaniel
<ul><li><strong>Status</strong> changed from <i>Feedback</i> to <i>In Progress</i></li><li><strong>% Done</strong> changed from <i>80</i> to <i>60</i></li></ul><p>Even most of the current statistics in the manuals are outdated. A while back I wrote a script to automate getting the VTY reference and counter documentation from our -master docker containers. This stalled because of difficulties using osmo-config-merge in these images in order to change the config file on-the-fly. I'm rebasing and reviewing this script now to update all the generated counter (and VTY while I'm at it) documentation.</p>
<p>I'm running it manually for now, but in the future it would be nice to have it automated.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=147632019-06-07T13:13:37Zdaniel
<ul><li><b>Checklist item</b> <input type='checkbox' class='checklist-checkbox' disabled> <i>Update osmo-bsc docs</i> added</li><li><strong>% Done</strong> changed from <i>60</i> to <i>70</i></li></ul><p><a class="external" href="https://gerrit.osmocom.org/c/osmo-bsc/+/14388">https://gerrit.osmocom.org/c/osmo-bsc/+/14388</a> has been merged which adds updated vty and counter documentation for osmo-bsc.</p>
<p>Changes<br /><a class="external" href="https://gerrit.osmocom.org/c/osmo-bsc/+/14404">https://gerrit.osmocom.org/c/osmo-bsc/+/14404</a> and<br /><a class="external" href="https://gerrit.osmocom.org/c/docker-playground/+/14403">https://gerrit.osmocom.org/c/docker-playground/+/14403</a><br />add some infrastructure to regenerate the docs automatically in the future.</p>
<p>This is not (yet) done automatically during the build process.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=148762019-06-19T10:08:59Zdaniel
<ul><li><strong>Subject</strong> changed from <i>Document existing statistics/counters of OsmoNITB, OsmoSGSN, OsmoBTS, OsmoPCU</i> to <i>Update/add counter and/or vty documentation for osmo-* programs</i></li><li><strong>% Done</strong> changed from <i>70</i> to <i>80</i></li></ul><p>Changed the title to better reflect the ongoing work.</p>
<p>See <a class="external" href="https://gerrit.osmocom.org/q/topic:+doc_regen">https://gerrit.osmocom.org/q/topic:+doc_regen</a> for a list of changes associated with this issue.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=148842019-06-19T13:00:33Zdaniel
<ul><li><b>Checklist item</b> deleted (<strike><i>Update osmo-bsc docs</i></strike>)</li><li><strong>% Done</strong> changed from <i>80</i> to <i>90</i></li></ul><p>I'm waiting for all the changes to get merged, then this should be done.</p>
vty/counter documentation is updated for:
<ul>
<li>osmo-bsc</li>
<li>osmo-msc</li>
<li>osmo-hlr</li>
<li>osmo-ggsn</li>
<li>osmo-stp</li>
<li>osmo-pcu</li>
<li>osmo-mgw</li>
<li>osmo-sgsn</li>
<li>osmo-sip-connector</li>
<li>openbsc - nitb</li>
</ul>
<p>I encountered some issues with the following projects:</p>
<ul>
<li>osmo-iuh and osmo-trx do not have any manuals or VTY reference</li>
<li>osmo-bts only generates documentation for osmo-bts-virtual. If we also want the device-specific commands we need to add/generate multiple vty reference manuals.</li>
<li>openbsc - bscnat: I updated the vty reference and added the counter description, but there is no manual to include the counter description. Adding a manual for osmo-bscnat is probably low priority as not many are using it.</li>
</ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=148892019-06-19T15:47:11ZHoernchen
<ul></ul><p>Something appears to be broken in chapter 14 of the osmo-bsc manual, the table is repeated three times.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=154192019-07-26T08:02:59Zdaniel
<ul><li><strong>Blocked by</strong> deleted (<i><a class="issue tracker-1 status-1 priority-2 priority-default" href="/issues/3417">Bug #3417</a>: show asciidoc counters does not show all the counters available</i>)</li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=154202019-07-26T08:03:06Zdaniel
<ul><li><strong>Related to</strong> <i><a class="issue tracker-1 status-1 priority-2 priority-default" href="/issues/3417">Bug #3417</a>: show asciidoc counters does not show all the counters available</i> added</li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=154222019-07-26T08:06:01Zdaniel
<ul><li><strong>% Done</strong> changed from <i>90</i> to <i>100</i></li></ul><p>All the remaining issues with duplicate counters and the sgsn not having Iu VTY commands are now resolved, all patches merged.</p> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=154232019-07-26T08:06:15Zdaniel
<ul><li><strong>Status</strong> changed from <i>In Progress</i> to <i>Resolved</i></li></ul> Cellular Network Infrastructure - Feature #1700: Update/add counter and/or vty documentation for osmo-* programshttps://projects.osmocom.org/issues/1700?journal_id=222682021-06-15T15:58:34Zlaforge
<ul><li><strong>Related to</strong> <i><a class="issue tracker-2 status-6 priority-2 priority-default closed" href="/issues/4044">Feature #4044</a>: regenerate vty reference during release process</i> added</li></ul>