mirror of
https://github.com/open5gs/open5gs.git
synced 2025-10-23 07:41:57 +00:00
794c63276e
Open5GS has a lightweight HTTP server (already used for `/metrics`) embedded in each NF. New optional JSON endpoints were added: | NF | Endpoint | Content | | --- | --- | --- | | **SMF** | `/pdu-info` | All currently connected UEs + their PDU sessions (IMSI/SUPI, DNN, IPs, S-NSSAI, QoS, state, etc.) | | **AMF** | `/gnb-info` | All currently connected gNBs and their supported TAs, PLMNs, SCTP info, number of UEs | | **AMF** | `/ue-info` | All currently connected NR UEs and their info, active gNB, tai, security, slices, am_policy | | **MME** | `/enb-info` | All currently connected eNBs and their supported TAs, PLMNs, SCTP info, number of UEs | | **MME** | `/ue-info` | All currently connected LTE UEs and their info, active eNB, tai, pdn info | They are exposed on the same HTTP port used by Prometheus metrics (default `:9090`). To reduce processor load when there are a large number of devices, the API includes a pager that limits output. `/ue-info?page=0&page_size=100` page in the range 0-n (0 is default), `page=-1` to avoid paging `page_size=100` (default and MAX)
70 lines
2.3 KiB
C
70 lines
2.3 KiB
C
/*
|
|
* Copyright (C) 2025 by Juraj Elias <juraj.elias@gmail.com>
|
|
*
|
|
* This file is part of Open5GS.
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
/*
|
|
* /ue-info — MME-side JSON exporter (Prometheus HTTP endpoint)
|
|
*
|
|
* License: AGPLv3+
|
|
*/
|
|
|
|
/* lib/metrics/prometheus/json_pager.h */
|
|
|
|
#ifndef OGS_METRICS_PROM_JSON_PAGER_H
|
|
#define OGS_METRICS_PROM_JSON_PAGER_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
|
|
/* Forward-declare so callers don't need to include cJSON.h here */
|
|
typedef struct cJSON cJSON;
|
|
|
|
/* Safe start_index = page * page_size with overflow guard. */
|
|
size_t json_pager_safe_start_index(bool no_paging, size_t page, size_t page_size);
|
|
|
|
/* Append trailing { "pager": { page, page_size, count, [truncated], prev?, next? } }. */
|
|
void json_pager_add_trailing(cJSON *root,
|
|
bool no_paging,
|
|
size_t page,
|
|
size_t page_size,
|
|
size_t count,
|
|
bool has_next,
|
|
const char *base_path,
|
|
bool truncated);
|
|
|
|
/* Finalize JSON into buf and free root. */
|
|
size_t json_pager_finalize(cJSON *root, char *buf, size_t buflen);
|
|
|
|
/* Paging step helper
|
|
* Returns: 1 -> CONTINUE (skip), 2 -> BREAK (page full; set has_next), 0 -> EMIT.
|
|
*/
|
|
static inline int
|
|
json_pager_advance(bool no_paging,
|
|
size_t idx, size_t start_index,
|
|
size_t emitted, size_t page_size,
|
|
bool *has_next)
|
|
{
|
|
if (no_paging) return 0;
|
|
if (idx < start_index) return 1;
|
|
if (emitted == page_size) { if (has_next) *has_next = true; return 2; }
|
|
return 0;
|
|
}
|
|
|
|
#endif /* OGS_METRICS_PROM_JSON_PAGER_H */
|
|
|
|
|