Kamal: Created page with "= Charting Server = The Charting Server processes time series queries on market data and publishes ongoing updates to clients. It performs calculations such as candlestick agg..."

2025-12-01T21:52:36Z

Created page with "= Charting Server = The Charting Server processes time series queries on market data and publishes ongoing updates to clients. It performs calculations such as candlestick agg..."

New page

= Charting Server =
The Charting Server processes time series queries on market data and publishes ongoing updates to clients. It performs calculations such as candlestick aggregation, technical indicators, and other analytical transformations over historical and real-time market data. By centralizing these computations, the server enables multiple clients to subscribe to identical chart data without redundant calculation overhead.

The Charting Server integrates with the Service Locator for authentication and service registration. Multiple Charting Servers can be deployed concurrently to distribute query processing load across instances with the Service Locator performing the load balancing among them.

== Configuration ==
The Charting Server is configured via a YAML file that defines its network interface and Service Locator integration. Below is the structure of the configuration file with example values:

<pre>
---
server:
# Primary network interface and port the Charting Server binds to.
interface: "0.0.0.0:21400"

# List of addresses the server is reachable at (for registration with Service Locator).
# Typically includes both public-facing and local addresses.
addresses: ["198.51.100.5:21400", "10.0.0.5:21400"]

service_locator:
# The address of the Service Locator (host:port).
address: "10.0.0.5:20000"

# The account username used by the Charting Server to authenticate with the Service Locator.
username: charting_service

# The password for the Charting Server's Service Locator account.
password: admin_password
...
</pre>

== Installation & Setup ==
A <code>setup.py</code> script is provided to generate the final <code>config.yml</code> from the <code>config.default.yml</code> template.

The script supports the following arguments:

<pre>
python setup.py
--local 0.0.0.0 # Local interface (default: auto-detected IP)
--world 198.51.100.5 # Global/public interface (optional)
--address 10.0.0.5:20000 # Service Locator address (default: local_interface:20000)
--password [REQUIRED] # Service password for authentication
</pre>

== Operations ==
The Charting Server is controlled using three operational scripts: <code>start.sh</code>, <code>stop.sh</code>, and <code>check.sh</code>.

Log files are generated in the format:
<pre>
srv_YYYYMMDD_HH_MM_SS.log
</pre>

Upon startup, older log files are moved into the <code>logs/</code> directory.

=== check.sh ===
The <code>check.sh</code> script verifies whether the server is currently running by inspecting the PID recorded in <code>pid.lock</code> and testing whether the associated process exists.

If the server is not running, it prints:
<pre>
ChartingServer is not running.
</pre>

=== start.sh ===
The <code>start.sh</code> script:
* Exits immediately if the server is already running
* Creates a <code>logs/</code> directory if necessary
* Moves any existing <code>srv_*.log</code> files into <code>logs/</code>
* Starts the <code>ChartingServer</code> process in the background
* Writes the PID to <code>pid.lock</code>
* Reads network interfaces from <code>config.yml</code> and waits until the server is listening on at least one configured address

This ensures the server is fully initialized before the script exits.

=== stop.sh ===
The <code>stop.sh</code> script:
* Reads the PID from <code>pid.lock</code>
* Sends <code>SIGINT</code> to request a graceful shutdown
* Waits for termination using exponential backoff (up to 300 seconds)
* Sends <code>SIGKILL</code> if the server fails to stop cleanly
* Appends a forced-termination message to the most recent log file (if applicable)
* Removes the <code>pid.lock</code> file

This guarantees consistent shutdown behavior across normal and exceptional conditions.

Charting Server - Revision history

Kamal: Created page with "= Charting Server = The Charting Server processes time series queries on market data and publishes ongoing updates to clients. It performs calculations such as candlestick agg..."