Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add $request_id into the websocket open log. #10

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add $request_id into the websocket open log. #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5bb966d
fix lines in the websocket log truncated
qdongxu Aug 22, 2023
22d57d3
fix the request_id absent from the open event in the websocket log
qdongxu Aug 22, 2023
4cad743
add variable $ws_total_payload_size to record the total size on one w…
qdongxu Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Here is a list of variables you can use in log format string:

* $ws_opcode - websocket packet opcode. Look into https://tools.ietf.org/html/rfc6455 Section 5.2, Base Framing Protocol.
* $ws_payload_size - Websocket packet size without protocol specific data. Only data that been sent or received by the client
* $ws_total_payload_size - total packet size on a Websocket connection, without protocol specific data. Only data that been sent or received by the client
* $ws_packet_source - Could be "client" if packet has been sent by the user or "upstream" if it has been received from the server
* $ws_conn_age - Number of seconds connection is alive
* $time_local - Nginx local time, date and timezone
Expand Down
4 changes: 3 additions & 1 deletion ngx_http_websocket_stat_format.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#include <ngx_core.h>
#include <ngx_http.h>
#include <assert.h>
#include <ctype.h>
#include <stdlib.h>
Expand All @@ -12,7 +14,7 @@ size_t HTTP_VAR_LEN = sizeof("$http_") - 1;

template_variable null_variable = {NULL, 0, 0, NULL};
const char *http_header_var(ngx_http_request_t *r, void *data);
template_variable header_variable = {NULL, 0, 50, http_header_var};
template_variable header_variable = {NULL, 0, 150, http_header_var};

typedef struct {
const template_variable *variable;
Expand Down
101 changes: 68 additions & 33 deletions ngx_http_websocket_stat_module.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
#include "ngx_http_websocket_stat_format.h"
#include "ngx_http_websocket_stat_frame_counter.h"
#include <assert.h>
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_http.h>

#include "ngx_http_websocket_stat_format.h"
#include "ngx_http_websocket_stat_frame_counter.h"
#include <assert.h>

#include <openssl/bio.h>
#include <openssl/evp.h>
#include <openssl/sha.h>
Expand Down Expand Up @@ -99,7 +100,7 @@ websocket_log(char *str)
void
ws_do_log(compiled_template *template, ngx_http_request_t *r, void *ctx)
{
if (ws_log) {
if (ws_log && template) {
char *log_line = apply_template(template, r, ctx);
websocket_log(log_line);
free(log_line);
Expand Down Expand Up @@ -329,14 +330,15 @@ my_send(ngx_connection_t *c, u_char *buf, size_t size)
ngx_atomic_fetch_add(frame_counter->frames, 1);
ngx_atomic_fetch_add(frame_counter->total_payload_size,
ctx->frame_counter.current_payload_size);
ctx->frame_counter.total_payload_size += ctx->frame_counter.current_payload_size;
ws_do_log(log_template, r, &template_ctx);
}
}
int n = orig_send(c, buf, size);
if (n < 0) {
if(!ngx_atomic_cmp_set(ngx_websocket_stat_active, 0, 0)){
ngx_atomic_fetch_add(ngx_websocket_stat_active, -1);
ws_do_log(log_close_template, r, &template_ctx);
if (!ngx_atomic_cmp_set(ngx_websocket_stat_active, 0, 0)) {
ngx_atomic_fetch_add(ngx_websocket_stat_active, -1);
ws_do_log(log_close_template, r, &template_ctx);
}
}
return n;
Expand Down Expand Up @@ -370,6 +372,7 @@ my_recv(ngx_connection_t *c, u_char *buf, size_t size)
ngx_atomic_fetch_add(frame_counter->frames, 1);
ngx_atomic_fetch_add(frame_counter->total_payload_size,
ctx->frame_counter.current_payload_size);
ctx->frame_counter.total_payload_size += ctx->frame_counter.current_payload_size;
ws_do_log(log_template, r, &template_ctx);
}
}
Expand Down Expand Up @@ -401,10 +404,13 @@ ngx_http_websocket_stat_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
if (ctx == NULL) {
return NGX_HTTP_INTERNAL_SERVER_ERROR;
}
template_ctx.ws_ctx = ctx;

const char *request_id_str = get_core_var(r, "request_id");
ctx->connection_id.data = ngx_pcalloc(r->pool, UID_LENGTH + 1);
ctx->connection_id.len = UID_LENGTH;
memcpy(ctx->connection_id.data, request_id_str, UID_LENGTH + 1);
ctx->frame_counter.total_payload_size = 0;

ws_do_log(log_open_template, r, &template_ctx);
ngx_http_set_ctx(r, ctx, ngx_http_websocket_stat_module);
Expand All @@ -415,26 +421,26 @@ ngx_http_websocket_stat_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
ngx_atomic_fetch_add(ngx_websocket_stat_active, 1);
ctx->ws_conn_start_time = ngx_time();
} else {
if(!ngx_atomic_cmp_set(ngx_websocket_stat_active, 0, 0)){
ngx_atomic_fetch_add(ngx_websocket_stat_active, -1);
ws_do_log(log_close_template, r, &template_ctx);
if (!ngx_atomic_cmp_set(ngx_websocket_stat_active, 0, 0)) {
ngx_atomic_fetch_add(ngx_websocket_stat_active, -1);
ws_do_log(log_close_template, r, &template_ctx);
}
}
}

return ngx_http_next_body_filter(r, in);
}

char buff[100];

const char *
ws_packet_type(ngx_http_request_t *r, void *data)
{
template_ctx_s *ctx = data;
ngx_frame_counter_t *frame_cntr = &(ctx->ws_ctx->frame_counter);
if (!ctx || !frame_cntr)
return UNKNOWN_VAR;
sprintf(buff, "%d", frame_cntr->current_frame_type);

char* buff = ngx_pcalloc(r->pool, NGX_ATOMIC_T_LEN);
snprintf(buff, NGX_ATOMIC_T_LEN, "%d", frame_cntr->current_frame_type);
return buff;
}

Expand All @@ -445,7 +451,22 @@ ws_packet_size(ngx_http_request_t *r, void *data)
ngx_frame_counter_t *frame_cntr = &ctx->ws_ctx->frame_counter;
if (!ctx || !frame_cntr)
return UNKNOWN_VAR;
sprintf(buff, "%lu", frame_cntr->current_payload_size);

char* buff = ngx_pcalloc(r->pool, NGX_ATOMIC_T_LEN);
snprintf(buff, NGX_ATOMIC_T_LEN, "%lu", frame_cntr->current_payload_size);
return (char *)buff;
}

const char *
ws_total_payload_size(ngx_http_request_t *r, void *data)
{
template_ctx_s *ctx = data;
ngx_frame_counter_t *frame_cntr = &ctx->ws_ctx->frame_counter;
if (!ctx || !frame_cntr)
return UNKNOWN_VAR;

char* buff = ngx_pcalloc(r->pool, NGX_ATOMIC_T_LEN);
snprintf(buff, NGX_ATOMIC_T_LEN, "%lu", frame_cntr->total_payload_size);
return (char *)buff;
}

Expand All @@ -472,6 +493,7 @@ get_core_var(ngx_http_request_t *r, const char *variable)
key = ngx_hash(key, *(variable++));

vv = ngx_http_get_variable(r, &var, key);
char* buff = ngx_pcalloc(r->pool, vv->len + 1);
memcpy(buff, vv->data, vv->len);
buff[vv->len] = '\0';
return buff;
Expand All @@ -483,20 +505,26 @@ ws_connection_age(ngx_http_request_t *r, void *data)
template_ctx_s *ctx = data;
if (!ctx || !ctx->ws_ctx)
return UNKNOWN_VAR;
sprintf(buff, "%lu", ngx_time() - ctx->ws_ctx->ws_conn_start_time);

char* buff = ngx_pcalloc(r->pool, NGX_ATOMIC_T_LEN);
snprintf(buff, NGX_ATOMIC_T_LEN, "%lu", ngx_time() - ctx->ws_ctx->ws_conn_start_time);

return (char *)buff;
}

const char *
local_time(ngx_http_request_t *r, void *data)
{
return memcpy(buff, ngx_cached_http_time.data, ngx_cached_http_time.len);
char* buff = ngx_pcalloc(r->pool, ngx_cached_http_time.len + 1);
memcpy(buff, ngx_cached_http_time.data, ngx_cached_http_time.len);
buff[ngx_cached_http_time.len] = '\0';
return buff;
}

const char *
remote_ip(ngx_http_request_t *r, void *data)
{
char* buff = ngx_pcalloc(r->pool, r->connection->addr_text.len + 1);
memcpy(buff, r->connection->addr_text.data, r->connection->addr_text.len);
buff[r->connection->addr_text.len] = '\0';

Expand Down Expand Up @@ -542,13 +570,14 @@ GEN_CORE_GET_FUNC(server_port, "server_port")
const template_variable variables[] = {
{VAR_NAME("$ws_opcode"), sizeof("ping") - 1, ws_packet_type},
{VAR_NAME("$ws_payload_size"), NGX_SIZE_T_LEN, ws_packet_size},
{VAR_NAME("$ws_total_payload_size"), NGX_SIZE_T_LEN, ws_total_payload_size},
{VAR_NAME("$ws_packet_source"), sizeof("upstream") - 1, ws_packet_source},
{VAR_NAME("$ws_conn_age"), NGX_SIZE_T_LEN, ws_connection_age},
{VAR_NAME("$time_local"), sizeof("Mon, 23 Oct 2017 11:27:42 GMT") - 1,
local_time},
{VAR_NAME("$upstream_addr"), 60, upstream_addr},
{VAR_NAME("$request"), 60, request},
{VAR_NAME("$uri"), 60, uri},
{VAR_NAME("$upstream_addr"), 160, upstream_addr},
{VAR_NAME("$request"), 160, request},
{VAR_NAME("$uri"), 160, uri},
{VAR_NAME("$request_id"), UID_LENGTH, request_id},
{VAR_NAME("$remote_user"), 60, remote_user},
{VAR_NAME("$remote_addr"), 60, remote_addr},
Expand Down Expand Up @@ -582,12 +611,18 @@ ngx_http_ws_log_format(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "Wrong argument number");
return NGX_CONF_ERROR;
}

if (cf->args->nelts == 2) {
log_template =
compile_template((char *)args[1].data, variables, cf->pool);
return NGX_CONF_OK;

}
if (strcmp((char *)args[1].data, "close") == 0) {
if (strcmp((char *)args[1].data, "packet") == 0) {
log_template =
compile_template((char *)args[2].data, variables, cf->pool);
return NGX_CONF_OK;
} else if (strcmp((char *)args[1].data, "close") == 0) {
log_close_template =
compile_template((char *)args[2].data, variables, cf->pool);
return NGX_CONF_OK;
Expand Down Expand Up @@ -697,7 +732,7 @@ complete_ws_handshake(ngx_connection_t *connection, const char *ws_key)
Base64Encode(hash, SHA_DIGEST_LENGTH, access_key, ACCEPT_SIZE);
access_key[ACCEPT_SIZE] = '\0';
char resp[256];
sprintf(resp, resp_template, access_key);
snprintf(resp, 256, resp_template, access_key);
ngx_log_error(NGX_LOG_ERR, ngx_cycle->log, 0,
"Websocket connection closed");
connection->send(connection, (unsigned char *)resp, strlen(resp));
Expand Down Expand Up @@ -743,18 +778,18 @@ ngx_http_websocket_stat_init(ngx_conf_t *cf)
ngx_http_next_body_filter = ngx_http_top_body_filter;
ngx_http_top_body_filter = ngx_http_websocket_stat_body_filter;

if (!log_template) {
log_template =
compile_template(default_log_template_str, variables, cf->pool);
}
if (!log_open_template) {
log_open_template = compile_template(default_open_log_template_str,
variables, cf->pool);
}
if (!log_close_template) {
log_close_template = compile_template(default_close_log_template_str,
variables, cf->pool);
}
// if (!log_template) {
// log_template =
// compile_template(default_log_template_str, variables, cf->pool);
// }
// if (!log_open_template) {
// log_open_template = compile_template(default_open_log_template_str,
// variables, cf->pool);
// }
// if (!log_close_template) {
// log_close_template = compile_template(default_close_log_template_str,
// variables, cf->pool);
// }

ngx_http_handler_pt *h;
ngx_http_core_main_conf_t *cmcf;
Expand Down