Project

General

Profile

Feature #1651

document the control interface(s) of the various programs

Added by laforge almost 2 years ago. Updated over 1 year ago.

Status:
Closed
Priority:
High
Assignee:
Target version:
-
Start date:
03/11/2016
Due date:
% Done:

100%

Spec Reference:

Description

Now that we have documentation for the Abis and Gb interfaces, it would be great to also document the control interface of every Osmo* process.

The documentation should probably be part of the respective programs user manual, rather than a separate manual.


Related issues

Related to Cellular Infrastructure - Feature #1700: Document existing statistics/counters of OsmoNITB, OsmoSGSN, OsmoBTS, OsmoPCU Feedback 05/04/2016
Blocked by libosmocore - Bug #1730: control interface: read rate couters doesn't work Closed 05/19/2016

History

#1 Updated by laforge almost 2 years ago

  • Assignee set to msuraev

#2 Updated by laforge over 1 year ago

  • Priority changed from Normal to High

#3 Updated by msuraev over 1 year ago

  • Status changed from New to In Progress

#4 Updated by msuraev over 1 year ago

Shall we also document all the individual (rate) counters available via ctrl interface?

#5 Updated by msuraev over 1 year ago

  • Related to Feature #1700: Document existing statistics/counters of OsmoNITB, OsmoSGSN, OsmoBTS, OsmoPCU added

#6 Updated by laforge over 1 year ago

Hi Max,

On Mon, May 09, 2016 at 10:48:44AM +0000, ms [REDMINE] wrote:

Shall we also document all the individual (rate) counters available via ctrl interface?

yes, though I think that belongs to the "KPI" related tickets, not in
this one. It should be sufficient to document how (rate) counters can
be read by the control interface in general, with a few examples.

The actual counters available in each program are then documented as
part of the respective "KPI" ticket.

--
- Harald Welte <> http://laforge.gnumonks.org/ ============================================================================
"Privacy in residential applications is a desirable marketing option."
(ETSI EN 300 175-7 Ch. A6)

#7 Updated by msuraev over 1 year ago

  • Blocked by Bug #1730: control interface: read rate couters doesn't work added

#8 Updated by msuraev over 1 year ago

The current version is available in max/ctrl branch of osmo-gsm-manuals repo.

#9 Updated by laforge over 1 year ago

msuraev wrote:

The current version is available in max/ctrl branch of osmo-gsm-manuals repo.

In that branch I could only find a single commit adding the OsmoBSC snippet of a few lines. Please check if you have some local commits for all the other programs pending? Where is the related documentation?

#10 Updated by msuraev over 1 year ago

I've force-pushed it - there should be 5 commits with additions for different manuals.

#11 Updated by laforge over 1 year ago

  • Status changed from In Progress to Resolved

#12 Updated by msuraev over 1 year ago

  • Assignee changed from msuraev to laforge
  • % Done changed from 0 to 100

#13 Updated by laforge over 1 year ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF