Project

General

Profile

Feature #1700

Update/add counter and/or vty documentation for osmo-* programs

Added by laforge over 3 years ago. Updated 3 months ago.

Status:
Resolved
Priority:
High
Assignee:
Target version:
-
Start date:
05/04/2016
Due date:
% Done:

100%

Spec Reference:

Description

there are some statistics/counters available in OsmoNITB, OsmoSGSN, OsmoBTS, OsmoPCU

Please identify all of them and add documentation in the respective user manual.


Related issues

Related to Cellular Network Infrastructure - Feature #1651: document the control interface(s) of the various programsClosed03/11/2016

Related to Cellular Network Infrastructure - Bug #3417: show asciidoc counters does not show all the counters availableNew07/25/2018

Precedes OsmoNITB - Feature #1653: KPIs for OsmoNITBResolved05/05/201605/05/2016

History

#1 Updated by laforge over 3 years ago

#2 Updated by msuraev over 3 years ago

  • Related to Feature #1651: document the control interface(s) of the various programs added

#3 Updated by laforge over 3 years ago

  • Assignee changed from msuraev to lynxis

#4 Updated by laforge over 3 years ago

  • Priority changed from Normal to High

#5 Updated by lynxis over 3 years ago

how the old counters (statistics.c), the newer ones (rate_ctr.c) and the new stats system (stats.c) work together.

statistics.c ---> stats.c
rate_ctr.c   -|
stat_item.c  -| (group description has the same struct, items not)

I'll create a command to generate asciidoc tables which then included into the documentation.

#6 Updated by lynxis over 3 years ago

similiar to the table osmobts-abis.pdf Table 9: Messages compliant with TS 12.21
http://git.osmocom.org/osmo-gsm-manuals/tree/OsmoBTS/abis/oml.adoc

#7 Updated by laforge over 3 years ago

to re-cap what was discussed in person today:
  • 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
  • attempt to genrate one asciidoc table per counter group
    • the table should contain a hyperlink to a chapter-anchor which is generate dfrom the counter name in the code
  • the asciidoc output can then be amended with human-written further details about each of the counters

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.

#8 Updated by laforge over 3 years ago

https://gerrit.osmocom.org/#/c/70 is the related gerrit patch set

#9 Updated by laforge almost 3 years ago

please resolve the issue if completed, or at least update "% Done" and indicate which parts are missing.

#10 Updated by laforge almost 3 years ago

'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?

#11 Updated by laforge over 2 years ago

lynxis, any update to my last question 3 months ago?

#12 Updated by laforge over 2 years ago

yet another follow-up, three months after my last ping that was again three months later? This is not acceptable, sorry.

#13 Updated by lynxis almost 2 years ago

  • BTS doesn't have any counters.
  • MGW doesn't have any counters.
  • GGSN doesn't have any counters.
  • HLR doesn't even have the required vty command. Missing vty stats init?
  • libosmocore: remove empty osmo counters table
    - g5189
    - g5190

laforge: I've dropped the NITB part. Is this ok?

#14 Updated by lynxis almost 2 years ago

  • % Done changed from 0 to 80

#15 Updated by lynxis almost 2 years ago

  • Status changed from New to In Progress

#16 Updated by lynxis almost 2 years ago

  • Status changed from In Progress to Feedback

waiting for the git review

#17 Updated by laforge almost 2 years ago

  • Project changed from OsmoNITB to Cellular Network Infrastructure

#18 Updated by laforge over 1 year ago

  • Assignee changed from lynxis to daniel

#19 Updated by laforge over 1 year ago

let's try to get this to conclusion, please

#20 Updated by daniel about 1 year ago

  • Blocked by Bug #3417: show asciidoc counters does not show all the counters available added

#21 Updated by daniel 5 months ago

  • Status changed from Feedback to In Progress
  • % Done changed from 80 to 60

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.

I'm running it manually for now, but in the future it would be nice to have it automated.

#22 Updated by daniel 4 months ago

  • Checklist item Update osmo-bsc docs added
  • % Done changed from 60 to 70

https://gerrit.osmocom.org/c/osmo-bsc/+/14388 has been merged which adds updated vty and counter documentation for osmo-bsc.

Changes
https://gerrit.osmocom.org/c/osmo-bsc/+/14404 and
https://gerrit.osmocom.org/c/docker-playground/+/14403
add some infrastructure to regenerate the docs automatically in the future.

This is not (yet) done automatically during the build process.

#23 Updated by daniel 4 months ago

  • Subject changed from Document existing statistics/counters of OsmoNITB, OsmoSGSN, OsmoBTS, OsmoPCU to Update/add counter and/or vty documentation for osmo-* programs
  • % Done changed from 70 to 80

Changed the title to better reflect the ongoing work.

See https://gerrit.osmocom.org/q/topic:+doc_regen for a list of changes associated with this issue.

#24 Updated by daniel 4 months ago

  • Checklist item deleted (Update osmo-bsc docs)
  • % Done changed from 80 to 90

I'm waiting for all the changes to get merged, then this should be done.

vty/counter documentation is updated for:
  • osmo-bsc
  • osmo-msc
  • osmo-hlr
  • osmo-ggsn
  • osmo-stp
  • osmo-pcu
  • osmo-mgw
  • osmo-sgsn
  • osmo-sip-connector
  • openbsc - nitb

I encountered some issues with the following projects:

  • osmo-iuh and osmo-trx do not have any manuals or VTY reference
  • 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.
  • 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.

#25 Updated by Hoernchen 4 months ago

Something appears to be broken in chapter 14 of the osmo-bsc manual, the table is repeated three times.

#26 Updated by daniel 3 months ago

  • Blocked by deleted (Bug #3417: show asciidoc counters does not show all the counters available)

#27 Updated by daniel 3 months ago

  • Related to Bug #3417: show asciidoc counters does not show all the counters available added

#28 Updated by daniel 3 months ago

  • % Done changed from 90 to 100

All the remaining issues with duplicate counters and the sgsn not having Iu VTY commands are now resolved, all patches merged.

#29 Updated by daniel 3 months ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)