haivision / srt-prometheus-exporter Goto Github PK

Overview

Before open source, this repository should be ready to take issues, feature requests and incoming pull requests.
To get ready to take the contribution, basic and general procedure and guideline should be provided by maintainers.

What needs to be prepared?

• CONTRIBUTING.md
  • This describes general contribution guideline, we can just refer to https://github.com/Haivision/srt/blob/master/CONTRIBUTING.md.
• Issue Template and Feature Request Template

Feature request

Motivation

Coding Style should be provided to accept the PR as guideline.

Feature description

We can refer to Google C++ Style Guideline, and if necessary we can define our own policy and rules.

Implementation considerations

Provide coding style guideline on top page.

Overview

Current documentation structure is too simple and difficult to find sections cz many sections are included in tutorial and development. It would be nice to add installation section about supported platform and source code checkout, building so on. Then tutorial should be dedicated to the tutorial to run sample applications with more description, which currently it does not have almost no docs for this. besides as developer doc, we need to add sections like API, developer guide and so on.

Minor install procedure update, and this is part of Ubuntu 22.04 support reminder.
Currently it only supports Ubuntu 20.04 so that prometheus-cpp-dev package cannot be installed from apt repository, given that tutorial explains and includes the procedure to build the prometheus-cpp-dev from the source code.
When we support Ubuntu 22.04, we can install with following.

apt install -y prometheus-cpp-dev

Probably version dependency could be introduced, so that specific version might needs to be tagged.

Bug Report

Required Information

• Operating System:
  • Ubuntu 20.04
• SRT Version / Commit ID
• SRT Prometheus Exporter Commit ID

Description

Currently whatever the fixes are, workflow starts to build the images to make sure to compile process successfully completed.
But this is not required to change the documentation, it should avoid starting the build workflow if the PR is only targeted for documentation.

Feature request

Motivation

"Caller" and "listener" have special meaning in SRT. They are for different call modes, or roles in an SRT connection establishment.
But here in srt-exporter, in the samples and filter modes, what matters is whether the SRT user sends out data or receives in data.

To make less confusion, these words shold be replaced.

Feature description

According to "Secure Reliable Transport Protocol Deployment Guide", module "Introduction to SRT", chapter "Basic SRT concepts", "source" and "destination" are more proper words to be used here.

srt_caller -> srt_source
srt_listener -> srt_destination

Implementation considerations

Double check if there is any conflict with new names.

Additional information

I just realized that we did not put copyright in the header or implementation of each file. This should be addressed before disclosure.

Overview

Before making this public, we need to get to the license agreement with Haivision policy.

Consideration

I think we can just replace https://github.com/Haivision/srt-prometheus-exporter/blob/master/LICENSE.md into https://github.com/Haivision/srt/blob/master/LICENSE since this library is fully depends on https://github.com/Haivision/srt?

Overall

It is really important for the software development to keep the consistency and stability to make sure there is no build break in mainline.
This must be required to support to guarantee that this repository can be built against target platform in mainline default branch.
Since this is current build tool and procedure in this repository, this needs to be discussed in details but it would be better to be ready before open source to avoid possible build break in the mainline.

Description

W.I.P

Bug Report

Required Information

• Operating System:
  • Ubuntu 20.04 (docker container image ubuntu:20.04)
• SRT Version / Commit ID
  • v1.4.0 but any
• SRT Prometheus Exporter Commit ID
  • efd1168

Description

sample cannot be started because it cannot find the dynamic loading library according to the procedure.

Steps to reproduce the issue

root@tomoyafujita:~/docker_ws/SRT/srt-prometheus-exporter/sample# ./sample_app_srt_caller_c
./sample_app_srt_caller_c: error while loading shared libraries: libprometheus-cpp-pull.so.1.1: cannot open shared object file: No such file or directory

Expected Behavior

./sample_app_srt_caller_c should be started w/o any error.

Actual Behavior

failed to start the execuable.

Additional information

LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib should be set if we use /usr/local/lib during sample explanation.

SRT Prometheus Exporter is dependent on prometheus-cpp, and install procedure tells git submodule init to pull the dependent submodules, but it does not exist.
I believe this is the problems during transition from internal repository to publication.

This repository does not include extended SRT statistics property for SRT gstreamer element.
That is said it would be better to update or adjust the architecture diagram described in https://github.com/Haivision/srt-prometheus-exporter#motivation to be aligned with implementation design.

Feature request

Motivation

follow up of #20.
coding style needs to be checked by every single PR and commits to make sure incoming PRs are compatible with current development policy.

Feature description

We can rely on cpplint, and integrate it to github workflow.

Feature request

Motivation

Currently Ubuntu 20.04 is only officially support, which has been 3 years already.
Adding support for Ubuntu 22.04 would be nice to have.

Feature description

Ubuntu 22.04 Jammy Support

Additional information

This needs to be done before #11

I'm sorry it maybe a stupid question..I tried to build the project，when I do:
cmake .. -DBUILD_SHARED_LIBS=ON
It errors like this:
CMake Error: The source directory "/Promethus/srt-prometheus-exporter" does not appear to contain CMakeLists.txt.
so maybe the source misses a file named"CMakeLists.txt"?