File: bandwidth_file.rst

package info (click to toggle)
sbws 2.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 16,084 kB
  • sloc: python: 10,432; sh: 146; makefile: 38
file content (37 lines) | stat: -rw-r--r-- 2,098 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
.. _bandwidth_file:

``BandwidthFile`` modifications
===============================

Code to modify when a new ``KeyValue`` is added
-----------------------------------------------

In the case of a ``KeyValue`` that comes from the configuration file::

    docs/source/config.example.ini
    docs/source/examples/sbws.example.ini
    sbws/config.default.ini
    sbws/core/generate.py
    sbws/globals.py
    sbws/lib/v3bwfile.py
    sbws/util/config.py
    tests/integration/sbws_testnet.ini
    tests/unit/lib/test_v3bwfile.py
    tests/unit/util/test_config.py

Other repositories that need to be modified:

- `Tor specifications`_: `bandwidth-file-spec`_
- `metrics Library`_: `BandwidthFile.java`_ , `BandwidthFileImpl.java`_
- `descriptorParser`_: `BandwidthParser.java`_
- `Metrics SQL Tables`_: `bandwidth_tables.sql`_

.. _bandwidth_tables.sql: https://gitlab.torproject.org/tpo/network-health/metrics/metrics-sql-tables/-/blob/95bb0e657f8c86e3bc92ca44273e92b1899052ee/bandwidth_tables.sql
.. _bandwidth-file-spec: https://gitlab.torproject.org/tpo/core/torspec/-/tree/main/spec/bandwidth-file-spec
.. _BandwidthFile.java: https://gitlab.torproject.org/tpo/network-health/metrics/library/-/blob/021bdac6e250f7561ada24e55b7ec51edba20883/src/main/java/org/torproject/descriptor/BandwidthFile.java
.. _BandwidthFileImpl.java: https://gitlab.torproject.org/tpo/network-health/metrics/library/-/blob/021bdac6e250f7561ada24e55b7ec51edba20883/src/main/java/org/torproject/descriptor/impl/BandwidthFileImpl.java
.. _BandwidthParser.java: https://gitlab.torproject.org/tpo/network-health/metrics/descriptorParser/-/blob/d23f0209370563be1a015abd4702bc02b8ef7427/src/main/java/org/torproject/metrics/descriptorparser/parsers/BandwidthParser.java
.. _descriptorParser: https://gitlab.torproject.org/tpo/network-health/metrics/descriptorParser
.. _metrics Library: https://gitlab.torproject.org/tpo/network-health/metrics/library
.. _Metrics SQL Tables: https://gitlab.torproject.org/tpo/network-health/metrics/metrics-sql-tables
.. _Tor specifications: https://gitlab.torproject.org/tpo/core/torspec