lws-log-ship.h

Go to the documentation of this file.

/*
 * libwebsockets - small server side websockets and web server implementation
 *
 * Copyright (C) 2010 - 2026 Andy Green <andy@warmcat.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
struct lws_log_ship;

typedef struct lws_log_ship_line {
        uint64_t                seq;    
        uint64_t                t_us;   
        const char              *text;  
        const char              *tag;   
        size_t                  len;    
        int                     level;  
} lws_log_ship_line_t;

typedef int (*lws_log_ship_tagger_t)(const char *line, size_t len, char *tag,
                                     size_t tag_len);

typedef void (*lws_log_ship_store_cb_t)(void *opaque, const char *kind,
                                        const char *host, const char *inst,
                                        const lws_log_ship_line_t *lines,
                                        size_t count);

struct lws_log_ship_info {
        struct lws_vhost                *vhost;
        const char                      *url;
        const char                      *secret;
        const char                      *kind;
        const char                      *host;
        size_t                          backlog_max;
        lws_log_ship_store_cb_t         store;
        void                            *opaque;
        int                             client_ssl_flags;
        char                            no_sysinfo;
};

LWS_VISIBLE LWS_EXTERN struct lws_log_ship *
lws_log_ship_create(const struct lws_log_ship_info *info);

LWS_VISIBLE LWS_EXTERN int
lws_log_ship_link(struct lws_log_ship *ls, const char *url,
                  const char *secret);

LWS_VISIBLE LWS_EXTERN int
lws_log_ship_set_host(struct lws_log_ship *ls, const char *host);

LWS_VISIBLE LWS_EXTERN void
lws_log_ship_set_tagger(lws_log_ship_tagger_t tagger);

LWS_VISIBLE LWS_EXTERN void
lws_log_ship_destroy(struct lws_log_ship **pls);

LWS_VISIBLE LWS_EXTERN void
lws_log_ship_window(struct lws_log_ship *ls, uint64_t from_us,
                    uint64_t until_us, int lvl);

LWS_VISIBLE LWS_EXTERN struct lws_log_ship *
lws_log_ship_get(void);

LWS_VISIBLE LWS_EXTERN const char *
lws_log_ship_inst(struct lws_log_ship *ls);

LWS_VISIBLE LWS_EXTERN const char *
lws_log_ship_host(struct lws_log_ship *ls);

LWS_VISIBLE LWS_EXTERN uint64_t
lws_log_ship_utc_us(void);
 
/* the protocol names on the wire */
#define LWS_LOG_SHIP_WS_PROTOCOL        "lws-log-ingest"
#define LWS_LOG_SHIP_LINE_MAX           1024