Skip to main content

network_flow_logs

Creates, updates, deletes, gets or lists a network_flow_logs resource.

Overview​

Namenetwork_flow_logs
TypeResource
Idrailway.observability.network_flow_logs

Fields​

The following fields are returned by SELECT queries:

One row per NetworkFlowLog. A single network flow log entry.

NameDatatypeDescription
deployment_idstringThe deployment ID
deployment_instance_idstringThe deployment instance ID
flow_idstringUnique identifier for the flow
peer_service_idstringService instance ID of the peer (for service-to-service flows)
service_idstringThe service ID this flow belongs to
byte_countintegerNumber of bytes transferred
capture_endstringWhen the flow capture ended (ISO timestamp)
capture_startstringWhen the flow capture started (ISO timestamp)
directionstringTraffic direction (ingress or egress) (egress, ingress)
drop_causestringIf packets were dropped, the reason
dst_addrstringDestination IP address
dst_portintegerDestination port number
flow_statestringWhether the flow is partial or complete (complete, partial)
l4_latency_msnumberLayer 4 latency in milliseconds
l4_protocolstringLayer 4 protocol (TCP, UDP, ICMP, etc) (icmp, icmpv6, tcp, udp, unknown)
packet_countintegerNumber of packets transferred
peer_kindstringType of peer (service, internet, DNS, etc) (edge_proxy, internet, local_dns, service, unknown)
src_addrstringSource IP address
src_portintegerSource port number

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectenvironment_idafter_date, after_limit, anchor_date, before_date, before_limit, deployment_instance_id, filter, service_idFetch individual network flow logs for an environment. Backed by the Railway GraphQL query networkFlowLogs.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
environment_idstring
after_datestringLatest date to look for logs after the anchor.
after_limitintegerLimit logs returned after the anchor.
anchor_datestringTarget date time to look for logs.
before_datestringOldest date to look for logs before the anchor.
before_limitintegerLimit logs returned before the anchor.
deployment_instance_idstringFilter by deployment instance / sandbox ID (optional).
filterstringFilter expression (e.g., @protocol:tcp @direction:egress @dropped:true).
service_idstringFilter by service ID (optional).

SELECT examples​

Fetch individual network flow logs for an environment. Backed by the Railway GraphQL query networkFlowLogs.

SELECT
deployment_id,
deployment_instance_id,
flow_id,
peer_service_id,
service_id,
byte_count,
capture_end,
capture_start,
direction,
drop_cause,
dst_addr,
dst_port,
flow_state,
l4_latency_ms,
l4_protocol,
packet_count,
peer_kind,
src_addr,
src_port
FROM railway.observability.network_flow_logs
WHERE environment_id = '{{ environment_id }}' -- required
AND after_date = '{{ after_date }}'
AND after_limit = '{{ after_limit }}'
AND anchor_date = '{{ anchor_date }}'
AND before_date = '{{ before_date }}'
AND before_limit = '{{ before_limit }}'
AND deployment_instance_id = '{{ deployment_instance_id }}'
AND filter = '{{ filter }}'
AND service_id = '{{ service_id }}'
;