You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by bc...@apache.org on 2018/08/31 16:07:38 UTC
[trafficserver] branch 8.0.x updated: Plugin, makefile,
readme and schema
This is an automated email from the ASF dual-hosted git repository.
bcall pushed a commit to branch 8.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/8.0.x by this push:
new 88dd197 Plugin, makefile, readme and schema
88dd197 is described below
commit 88dd197135afee78f9de60cdbbe0803fba5f218c
Author: Zeyuan Yu <ze...@gmail.com>
AuthorDate: Thu Jun 14 18:32:23 2018 +0000
Plugin, makefile, readme and schema
(cherry picked from commit 345ca0427662278d6d152a1a65a6c8b626218dc7)
---
plugins/Makefile.am | 1 +
plugins/experimental/traffic_dump/Makefile.inc | 19 +
plugins/experimental/traffic_dump/README | 16 +
plugins/experimental/traffic_dump/traffic_dump.cc | 592 ++++++++++++++++++++++
tests/tools/lib/replay_schema.json | 209 ++++++++
5 files changed, 837 insertions(+)
diff --git a/plugins/Makefile.am b/plugins/Makefile.am
index 487978d..d58632d 100644
--- a/plugins/Makefile.am
+++ b/plugins/Makefile.am
@@ -79,6 +79,7 @@ include experimental/sslheaders/Makefile.inc
include experimental/stale_while_revalidate/Makefile.inc
include experimental/stream_editor/Makefile.inc
include experimental/system_stats/Makefile.inc
+include experimental/traffic_dump/Makefile.inc
include experimental/tls_bridge/Makefile.inc
include experimental/url_sig/Makefile.inc
include experimental/prefetch/Makefile.inc
diff --git a/plugins/experimental/traffic_dump/Makefile.inc b/plugins/experimental/traffic_dump/Makefile.inc
new file mode 100644
index 0000000..ac87596
--- /dev/null
+++ b/plugins/experimental/traffic_dump/Makefile.inc
@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+pkglib_LTLIBRARIES += experimental/traffic_dump/traffic_dump.la
+
+experimental_traffic_dump_traffic_dump_la_SOURCES = experimental/traffic_dump/traffic_dump.cc
diff --git a/plugins/experimental/traffic_dump/README b/plugins/experimental/traffic_dump/README
new file mode 100644
index 0000000..d4e1344
--- /dev/null
+++ b/plugins/experimental/traffic_dump/README
@@ -0,0 +1,16 @@
+Traffic Dump
+
+Description:
+Traffic Dump captures traffic through trafficserver on a per session basis. A sampling ratio can be set via plugin.config or traffic_ctl to dump one out of n sessions. The dump file schema can be found https://github.com/apache/trafficserver/tree/master/tests/tools/lib/replay_schema.json.
+
+Configuration:
+Traffic Dump is a global plugin and is configured by arguments in plugin.config.
+--logdir <path>
+ Specify a log directory for writing all dump files. If path is relative, it is relative to the Traffic Server directory. The plugin will use first three chars of client ip to create subdirs to spread dumps evenly and avoid too many files in a single directory.
+
+--sample <N>
+ The sampling ratio. By setting this number to N, Traffic Dump will capture every one out of N sessions. This ratio can also be changed via traffic_ctl without restarting ATS.
+
+Traffic_Ctl Command:
+traffic_ctl plugin msg traffic_dump.sample N
+ Same as setting --sample=N in plugin.config.
diff --git a/plugins/experimental/traffic_dump/traffic_dump.cc b/plugins/experimental/traffic_dump/traffic_dump.cc
new file mode 100644
index 0000000..acc61a3
--- /dev/null
+++ b/plugins/experimental/traffic_dump/traffic_dump.cc
@@ -0,0 +1,592 @@
+/** @traffic_dump.cc
+ Plugin Traffic Dump captures traffic on a per session basis. A sampling ratio can be set via plugin.config or traffic_ctl to dump
+ one out of n sessions. The dump file schema can be found
+ https://github.com/apache/trafficserver/tree/master/tests/tools/lib/replay_schema.json
+ @section license License
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ */
+
+#include <inttypes.h>
+
+#include <cstdio>
+#include <cstdlib>
+#include <cstring>
+#include <getopt.h>
+#include <unistd.h>
+
+#include <sys/stat.h>
+#include <sys/types.h>
+#include <fcntl.h>
+#include <errno.h>
+#include <arpa/inet.h>
+#include <netinet/in.h>
+
+#include <sstream>
+#include <iomanip>
+#include <chrono>
+#include <atomic>
+#include <string>
+
+#include "ts/ts.h"
+
+const char *PLUGIN_NAME = "traffic_dump";
+static const std::string closing = "]}]}";
+
+static std::string LOG_DIR = "dump"; // default log directory
+static int s_arg_idx = 0; // Session Arg Index to pass on session data
+static std::atomic<int64_t> sample_pool_size(1000); // Sampling ratio
+
+// handler declaration
+static int session_aio_handler(TSCont contp, TSEvent event, void *edata);
+static int session_txn_handler(TSCont contp, TSEvent event, void *edata);
+
+// Custom structure for per session data
+struct SsnData {
+ int log_fd = -1; // Log file descriptor
+ int aio_count = 0; // Active AIO counts
+ int64_t write_offset = 0; // AIO write offset
+ bool first = true; // First Transaction
+ bool ssn_closed = false; // Session closed flag
+
+ TSCont aio_cont = nullptr; // AIO callback
+ TSCont txn_cont = nullptr; // Transaction callback
+ TSMutex disk_io_mutex = nullptr; // AIO mutex
+
+ SsnData()
+ {
+ disk_io_mutex = TSMutexCreate();
+ aio_cont = TSContCreate(session_aio_handler, TSMutexCreate());
+ txn_cont = TSContCreate(session_txn_handler, nullptr);
+ }
+
+ ~SsnData()
+ {
+ if (disk_io_mutex) {
+ TSMutexDestroy(disk_io_mutex);
+ }
+ if (aio_cont) {
+ TSContDestroy(aio_cont);
+ }
+ if (txn_cont) {
+ TSContDestroy(txn_cont);
+ }
+ }
+
+ /// write_to_disk(): Takes a string object and writes to file via AIO
+ int
+ write_to_disk(const std::string &body)
+ {
+ TSMutexLock(disk_io_mutex);
+ char *pBuf = nullptr;
+ // Allocate a buffer for aio writing
+ if ((pBuf = static_cast<char *>(TSmalloc(sizeof(char) * body.size())))) {
+ memcpy(pBuf, body.c_str(), body.size());
+ if (TS_SUCCESS == TSAIOWrite(log_fd, write_offset, pBuf, body.size(), aio_cont)) {
+ // Update offset within file and aio events count
+ write_offset += body.size();
+ aio_count += 1;
+
+ TSMutexUnlock(disk_io_mutex);
+ return TS_SUCCESS;
+ }
+ TSfree(pBuf);
+ }
+ TSMutexUnlock(disk_io_mutex);
+ return TS_ERROR;
+ }
+};
+
+/// Local helper functions about json formatting
+/// min_write(): Inline function for repeating code
+static inline void
+min_write(const char *buf, int64_t &prevIdx, int64_t &idx, std::ostream &jsonfile)
+{
+ if (prevIdx < idx) {
+ jsonfile.write(buf + prevIdx, idx - prevIdx);
+ }
+ prevIdx = idx + 1;
+}
+
+/// esc_json_out(): Escape characters in a buffer and output to ofstream object
+/// in a way to minimize ofstream operations
+static int
+esc_json_out(const char *buf, int64_t len, std::ostream &jsonfile)
+{
+ if (buf == nullptr)
+ return 0;
+ int64_t idx, prevIdx = 0;
+ for (idx = 0; idx < len; idx++) {
+ char c = *(buf + idx);
+ switch (c) {
+ case '"':
+ case '\\': {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\" << c;
+ break;
+ }
+ case '\b': {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\b";
+ break;
+ }
+ case '\f': {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\f";
+ break;
+ }
+ case '\n': {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\n";
+ break;
+ }
+ case '\r': {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\r";
+ break;
+ }
+ case '\t': {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\t";
+ break;
+ }
+ default: {
+ if ('\x00' <= c && c <= '\x1f') {
+ min_write(buf, prevIdx, idx, jsonfile);
+ jsonfile << "\\u" << std::hex << std::setw(4) << std::setfill('0') << (int)c;
+ }
+ break;
+ }
+ }
+ }
+ min_write(buf, prevIdx, idx, jsonfile);
+
+ return len;
+}
+
+/// escape_json(): escape chars in a string and returns json string
+static std::string
+escape_json(std::string const &s)
+{
+ std::ostringstream o;
+ esc_json_out(s.c_str(), s.length(), o);
+ return o.str();
+}
+static std::string
+escape_json(const char *buf, int64_t size)
+{
+ std::ostringstream o;
+ esc_json_out(buf, size, o);
+ return o.str();
+}
+
+/// json_entry(): Formats to map-style entry i.e. "field": "value"
+// static inline std::string
+// json_entry(std::string const &name, std::string const &value)
+// {
+// return "\"" + escape_json(name) + "\": \"" + escape_json(value) + "\"";
+// }
+
+static inline std::string
+json_entry(std::string const &name, const char *buf, int64_t size)
+{
+ return "\"" + escape_json(name) + "\":\"" + escape_json(buf, size) + "\"";
+}
+
+/// json_entry_array(): Formats to array-style entry i.e. ["field","value"]
+// static inline std::string
+// json_entry_array(std::string const &name, std::string const &value)
+// {
+// return "[\"" + escape_json(name) + "\", \"" + escape_json(value) + "\"]";
+// }
+
+static inline std::string
+json_entry_array(const char *name, int name_len, const char *value, int value_len)
+{
+ return "[\"" + escape_json(name, name_len) + "\", \"" + escape_json(value, value_len) + "\"]";
+}
+
+/// Helper functions to collect txn information from TSMBuffer
+static std::string
+collect_headers(TSMBuffer &buffer, TSMLoc &hdr_loc, int64_t body_bytes)
+{
+ std::string result = "{";
+ int len = 0;
+ const char *cp = nullptr;
+ TSMLoc url_loc = nullptr;
+
+ // Log scheme+method or status+reason based on header type
+ if (TSHttpHdrTypeGet(buffer, hdr_loc) == TS_HTTP_TYPE_REQUEST) {
+ // 1. "version"
+ int version = TSHttpHdrVersionGet(buffer, hdr_loc);
+ result += R"("version":")" + std::to_string(TS_HTTP_MAJOR(version)) + "." + std::to_string(TS_HTTP_MINOR(version)) + '"';
+
+ // 2. "scheme":
+ TSAssert(TS_SUCCESS == TSHttpHdrUrlGet(buffer, hdr_loc, &url_loc));
+ cp = TSUrlSchemeGet(buffer, url_loc, &len);
+ TSDebug(PLUGIN_NAME, "collect_headers(): found scheme %d ", len);
+ result += "," + json_entry("scheme", cp, len);
+
+ // 3. "method":(string)
+ cp = TSHttpHdrMethodGet(buffer, hdr_loc, &len);
+ result += "," + json_entry("method", cp, len);
+
+ // 4. "url"
+ cp = TSUrlStringGet(buffer, url_loc, &len);
+ TSDebug(PLUGIN_NAME, "collect_headers(): found url %.*s", len, cp);
+ result += "," + json_entry("url", cp, len);
+ TSHandleMLocRelease(buffer, hdr_loc, url_loc);
+ } else {
+ // 1. "status":(string)
+ result += R"("status":)" + std::to_string(TSHttpHdrStatusGet(buffer, hdr_loc));
+ // 2. "reason":(string)
+ cp = TSHttpHdrReasonGet(buffer, hdr_loc, &len);
+ result += "," + json_entry("reason", cp, len);
+ // 3. "encoding"
+ }
+
+ // "content"
+ // "encoding"
+ // "size"
+ result += R"(,"content":{"encoding":"plain","size":)" + std::to_string(body_bytes) + '}';
+
+ // "headers": [[name(string), value(string)]]
+ result += R"(,"headers":{"encoding":"esc_json", "fields": [)";
+ TSMLoc field_loc = TSMimeHdrFieldGet(buffer, hdr_loc, 0);
+ while (field_loc) {
+ TSMLoc next_field_loc;
+ const char *name;
+ const char *value;
+ int name_len, value_len;
+ // Append to "fields" list if valid value exists
+ if ((name = TSMimeHdrFieldNameGet(buffer, hdr_loc, field_loc, &name_len)) && name_len) {
+ value = TSMimeHdrFieldValueStringGet(buffer, hdr_loc, field_loc, -1, &value_len);
+ result += json_entry_array(name, name_len, value, value_len);
+ }
+
+ next_field_loc = TSMimeHdrFieldNext(buffer, hdr_loc, field_loc);
+ TSHandleMLocRelease(buffer, hdr_loc, field_loc);
+ if ((field_loc = next_field_loc) != nullptr) {
+ result += ",";
+ }
+ }
+
+ return result + "]}}";
+}
+
+// Per session AIO handler: update AIO counts and clean up
+int
+session_aio_handler(TSCont contp, TSEvent event, void *edata)
+{
+ switch (event) {
+ case TS_AIO_EVENT_DONE: {
+ TSAIOCallback cb = static_cast<TSAIOCallback>(edata);
+ SsnData *ssnData = static_cast<SsnData *>(TSContDataGet(contp));
+ if (!ssnData) {
+ TSDebug(PLUGIN_NAME, "session_aio_handler(): No valid ssnData. Abort.");
+ return TS_ERROR;
+ }
+ char *buf = TSAIOBufGet(cb);
+ TSMutexLock(ssnData->disk_io_mutex);
+
+ // Free the allocated buffer and update aio_count
+ if (buf) {
+ TSfree(buf);
+ if (--ssnData->aio_count == 0 && ssnData->ssn_closed) {
+ // check for ssn close, if closed, do clean up
+ TSContDataSet(contp, nullptr);
+ close(ssnData->log_fd);
+ TSMutexUnlock(ssnData->disk_io_mutex);
+ delete ssnData;
+ return TS_SUCCESS;
+ }
+ }
+ TSMutexUnlock(ssnData->disk_io_mutex);
+ return TS_SUCCESS;
+ }
+ default:
+ TSDebug(PLUGIN_NAME, "session_aio_handler(): unhandled events %d", event);
+ return TS_ERROR;
+ }
+ return TS_SUCCESS;
+}
+
+// Transaction handler: writes headers to the log file using AIO
+int
+session_txn_handler(TSCont contp, TSEvent event, void *edata)
+{
+ TSHttpTxn txnp = static_cast<TSHttpTxn>(edata);
+
+ // Retrieve SsnData
+ TSHttpSsn ssnp = TSHttpTxnSsnGet(txnp);
+ SsnData *ssnData = static_cast<SsnData *>(TSHttpSsnArgGet(ssnp, s_arg_idx));
+
+ // If no valid ssnData, continue transaction as if nothing happened
+ if (!ssnData) {
+ TSDebug(PLUGIN_NAME, "session_txn_handler(): No ssnData found. Abort.");
+ TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE);
+ return TS_SUCCESS;
+ }
+
+ switch (event) {
+ case TS_EVENT_HTTP_TXN_CLOSE: {
+ // Get UUID
+ char uuid[TS_CRUUID_STRING_LEN + 1];
+ TSAssert(TS_SUCCESS == TSClientRequestUuidGet(txnp, uuid));
+
+ // Generate per transaction json records
+ std::string txn_info;
+ if (!ssnData->first) {
+ txn_info += ",";
+ }
+ ssnData->first = false;
+
+ // "uuid":(string)
+ txn_info += "{" + json_entry("uuid", uuid, strlen(uuid));
+
+ // "connect-time":(number)
+ TSHRTime start_time;
+ TSHttpTxnMilestoneGet(txnp, TS_MILESTONE_UA_BEGIN, &start_time);
+ txn_info += ",\"start-time\":" + std::to_string(start_time);
+
+ // client/proxy-request/response headers
+ TSMBuffer buffer;
+ TSMLoc hdr_loc;
+ if (TS_SUCCESS == TSHttpTxnClientReqGet(txnp, &buffer, &hdr_loc)) {
+ TSDebug(PLUGIN_NAME, "Found client request");
+ txn_info += R"(,"client-request":)" + collect_headers(buffer, hdr_loc, TSHttpTxnClientReqBodyBytesGet(txnp));
+ TSHandleMLocRelease(buffer, TS_NULL_MLOC, hdr_loc);
+ buffer = nullptr;
+ }
+ if (TS_SUCCESS == TSHttpTxnServerReqGet(txnp, &buffer, &hdr_loc)) {
+ TSDebug(PLUGIN_NAME, "Found proxy request");
+ txn_info += R"(,"proxy-request":)" + collect_headers(buffer, hdr_loc, TSHttpTxnServerReqBodyBytesGet(txnp));
+ TSHandleMLocRelease(buffer, TS_NULL_MLOC, hdr_loc);
+ buffer = nullptr;
+ }
+ if (TS_SUCCESS == TSHttpTxnServerRespGet(txnp, &buffer, &hdr_loc)) {
+ TSDebug(PLUGIN_NAME, "Found server response");
+ txn_info += R"(,"server-response":)" + collect_headers(buffer, hdr_loc, TSHttpTxnServerRespBodyBytesGet(txnp));
+ TSHandleMLocRelease(buffer, TS_NULL_MLOC, hdr_loc);
+ buffer = nullptr;
+ }
+ if (TS_SUCCESS == TSHttpTxnClientRespGet(txnp, &buffer, &hdr_loc)) {
+ TSDebug(PLUGIN_NAME, "Found proxy response");
+ txn_info += R"(,"proxy-response":)" + collect_headers(buffer, hdr_loc, TSHttpTxnClientRespBodyBytesGet(txnp));
+ TSHandleMLocRelease(buffer, TS_NULL_MLOC, hdr_loc);
+ buffer = nullptr;
+ }
+
+ txn_info += "}";
+ ssnData->write_to_disk(txn_info);
+ break;
+ }
+ default:
+ TSDebug(PLUGIN_NAME, "session_txn_handler(): Unhandled events %d", event);
+ TSHttpTxnReenable(txnp, TS_EVENT_HTTP_ERROR);
+ return TS_ERROR;
+ }
+
+ TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE);
+ return TS_SUCCESS;
+}
+
+// Session handler for global hooks; Assign per-session data structure and log files
+static int
+global_ssn_handler(TSCont contp, TSEvent event, void *edata)
+{
+ TSHttpSsn ssnp = static_cast<TSHttpSsn>(edata);
+
+ switch (event) {
+ // Also handles LIFECYCLE_MSG from traffic_ctl
+ case TS_EVENT_LIFECYCLE_MSG: {
+ TSPluginMsg *msg = static_cast<TSPluginMsg *>(edata);
+ if (strlen(msg->tag) == 19 && strncmp(msg->tag, "traffic_dump.sample", 19) == 0) {
+ sample_pool_size = static_cast<int64_t>(strtol(static_cast<const char *>(msg->data), nullptr, 0));
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): Received Msg to change sample size to %" PRId64 "", sample_pool_size.load());
+ }
+ return TS_SUCCESS;
+ }
+ case TS_EVENT_HTTP_SSN_START: {
+ // Grab session id to do sampling
+ int64_t id = TSHttpSsnIdGet(ssnp);
+ if (id % sample_pool_size != 0) {
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): Ignore session %" PRId64 "...", id);
+ break;
+ }
+ // Beginning of a new session
+ /// Get epoch time
+ auto start = std::chrono::duration_cast<std::chrono::nanoseconds>(std::chrono::system_clock::now().time_since_epoch());
+
+ // Create new per session data
+ SsnData *ssnData = new SsnData;
+ TSHttpSsnArgSet(ssnp, s_arg_idx, ssnData);
+
+ TSContDataSet(ssnData->aio_cont, ssnData);
+
+ // 1. "protocol":(string)
+ const char *protocol[10];
+ int count = 0;
+ TSAssert(TS_SUCCESS == TSHttpSsnClientProtocolStackGet(ssnp, 10, protocol, &count));
+ std::string result;
+ for (int i = 0; i < count; i++) {
+ if (i > 0) {
+ result += ",";
+ }
+ result += '"' + std::string(protocol[i]) + '"';
+ }
+
+ std::string beginning = R"({"meta":{"version":"1.0"},"sessions":[{"protocol":[)" + result + "]" + R"(,"connection-time":)" +
+ std::to_string(start.count()) + R"(,"transactions":[)";
+
+ // Grab session id and use its hex string as fname
+ std::stringstream stream;
+ stream << std::setw(16) << std::setfill('0') << std::hex << id;
+ std::string session_id = stream.str();
+
+ // Use client ip as sub directory name
+ char client_str[INET6_ADDRSTRLEN];
+ const sockaddr *client_ip = TSHttpSsnClientAddrGet(ssnp);
+ if (AF_INET == client_ip->sa_family) {
+ inet_ntop(AF_INET, &(reinterpret_cast<const sockaddr_in *>(client_ip)->sin_addr), client_str, INET_ADDRSTRLEN);
+ } else if (AF_INET6 == client_ip->sa_family) {
+ inet_ntop(AF_INET6, &(reinterpret_cast<const sockaddr_in6 *>(client_ip)->sin6_addr), client_str, INET6_ADDRSTRLEN);
+ } else {
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): Unknown address family.");
+ snprintf(client_str, INET6_ADDRSTRLEN, "unknown");
+ }
+
+ // Initialize AIO file
+ TSMutexLock(ssnData->disk_io_mutex);
+ if (ssnData->log_fd < 0) {
+ std::string path = LOG_DIR + "/" + std::string(client_str, 3);
+ std::string fname = path + "/" + session_id;
+
+ // Create subdir if not existing
+ struct stat st;
+ if (stat(path.c_str(), &st) == -1) {
+ if (mkdir(path.c_str(), 0755) == -1) {
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): failed to create dir (%d)%s", errno, strerror(errno));
+
+ TSError("[%s] Failed to create dir. %s", PLUGIN_NAME, strerror(errno));
+ }
+ }
+
+ // Try to open log files for AIO
+ ssnData->log_fd = open(fname.c_str(), O_RDWR | O_CREAT, S_IRWXU);
+ if (ssnData->log_fd < 0) {
+ TSMutexUnlock(ssnData->disk_io_mutex);
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): Failed to open log files. Abort.");
+ TSHttpSsnReenable(ssnp, TS_EVENT_HTTP_CONTINUE);
+ return TS_EVENT_HTTP_CONTINUE;
+ }
+
+ // Write log file beginning to disk
+ ssnData->write_to_disk(beginning);
+ }
+ TSMutexUnlock(ssnData->disk_io_mutex);
+
+ TSHttpSsnHookAdd(ssnp, TS_HTTP_TXN_CLOSE_HOOK, ssnData->txn_cont);
+ break;
+ }
+ case TS_EVENT_HTTP_SSN_CLOSE: {
+ // Write session and log file closing
+ int64_t id = TSHttpSsnIdGet(ssnp);
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): Closing session %" PRId64 "...", id);
+ // Retrieve SsnData
+ SsnData *ssnData = static_cast<SsnData *>(TSHttpSsnArgGet(ssnp, s_arg_idx));
+ // If no valid ssnData, continue transaction as if nothing happened
+ if (!ssnData) {
+ TSDebug(PLUGIN_NAME, "global_ssn_handler(): [TS_EVENT_HTTP_SSN_CLOSE] No ssnData found. Abort.");
+ TSHttpSsnReenable(ssnp, TS_EVENT_HTTP_CONTINUE);
+ return TS_SUCCESS;
+ }
+ ssnData->write_to_disk(closing);
+ TSMutexLock(ssnData->disk_io_mutex);
+ ssnData->ssn_closed = true;
+ TSMutexUnlock(ssnData->disk_io_mutex);
+
+ break;
+ }
+ default:
+ break;
+ }
+ TSHttpSsnReenable(ssnp, TS_EVENT_HTTP_CONTINUE);
+ return TS_SUCCESS;
+}
+
+void
+TSPluginInit(int argc, const char *argv[])
+{
+ TSDebug(PLUGIN_NAME, "initializing plugin");
+ TSPluginRegistrationInfo info;
+
+ info.plugin_name = "traffic_dump";
+ info.vendor_name = "Oath";
+ info.support_email = "edge@oath.com";
+
+ std::string installDir = TSInstallDirGet();
+ LOG_DIR = installDir + "/" + LOG_DIR + "/";
+
+ /// Commandline options
+ static const struct option longopts[] = {
+ {"logdir", required_argument, nullptr, 'l'}, {"sample", required_argument, nullptr, 's'}, {nullptr, no_argument, nullptr, 0}};
+ int opt = 0;
+ while (opt >= 0) {
+ opt = getopt_long(argc, (char *const *)argv, "l:", longopts, nullptr);
+ switch (opt) {
+ case 'l': {
+ LOG_DIR = std::string(optarg);
+ if (LOG_DIR[0] != '/') {
+ LOG_DIR = installDir + "/" + std::string(optarg) + "/";
+ }
+ TSDebug(PLUGIN_NAME, "Initialized with log dir: %s", LOG_DIR.c_str());
+ struct stat st;
+ if (stat(LOG_DIR.c_str(), &st) == -1) {
+ TSDebug(PLUGIN_NAME, "Log dir error: (%d) %s", errno, strerror(errno));
+ } else {
+ TSDebug(PLUGIN_NAME, "Log dir opened successfully");
+ }
+ break;
+ }
+ case 's': {
+ sample_pool_size = static_cast<int64_t>(std::strtol(optarg, nullptr, 0));
+ break;
+ }
+ case -1:
+ case '?':
+ break;
+
+ default:
+ TSDebug(PLUGIN_NAME, "Unexpected options.");
+ TSError("[%s] Unexpected options error.", PLUGIN_NAME);
+ return;
+ }
+ }
+
+ if (TS_SUCCESS != TSPluginRegister(&info)) {
+ TSError("[%s] Unable to initialize plugin (disabled). Failed to register plugin.", PLUGIN_NAME);
+ } else if (TS_SUCCESS != TSHttpSsnArgIndexReserve(PLUGIN_NAME, "Track log related data", &s_arg_idx)) {
+ TSError("[%s] Unable to initialize plugin (disabled). Failed to reserve ssn arg.", PLUGIN_NAME);
+ } else {
+ /// Add global hooks
+ TSCont ssncont = TSContCreate(global_ssn_handler, nullptr);
+ TSHttpHookAdd(TS_HTTP_SSN_START_HOOK, ssncont);
+ TSHttpHookAdd(TS_HTTP_SSN_CLOSE_HOOK, ssncont);
+ TSLifecycleHookAdd(TS_LIFECYCLE_MSG_HOOK, ssncont);
+ TSDebug(PLUGIN_NAME, "Initialized with sample pool size %" PRId64 "", sample_pool_size.load());
+ }
+
+ return;
+}
diff --git a/tests/tools/lib/replay_schema.json b/tests/tools/lib/replay_schema.json
new file mode 100644
index 0000000..5e15281
--- /dev/null
+++ b/tests/tools/lib/replay_schema.json
@@ -0,0 +1,209 @@
+{
+ "$schema": "https://github.com/apache/trafficserver/tree/master/tests/tools/lib/replay_schema.json",
+ "title": "Traffic Server Replay File",
+ "description": "Data for Traffic Server sessions and transactions. Licensed under Apache V2 https://www.apache.org/licenses/LICENSE-2.0",
+ "type": "object",
+ "properties": {
+ "meta": {
+ "description": "Metadata for the file.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "File format version.",
+ "type": "string"
+ }
+ }
+ },
+ "sessions": {
+ "description": "List of sessions",
+ "type": "array",
+ "items": {
+ "title": "Session",
+ "description": "Session data.",
+ "type": "object",
+ "required": [ "transactions" ],
+ "properties": {
+ "protocol": {
+ "description": "The network protocol stack of the inbound connection.",
+ "type": "array",
+ "items": {
+ "description": "Protocol tag",
+ "type": "string"
+ }
+ },
+ "connect-time": {
+ "description": "User Agent connection time.",
+ "type": "number"
+ },
+ "transactions": {
+ "description": "List of transactions",
+ "type": "array",
+ "items": {
+ "description": "Transaction",
+ "type": "object",
+ "required": [ "client-request", "server-response" ],
+ "properties": {
+ "uuid": {
+ "description": "UUID to identify this specific transaction.",
+ "type": "string"
+ },
+ "start-time": {
+ "description": "Start time in epoch format",
+ "type": "number"
+ },
+ "client-request": {
+ "description": "Request sent by the inbound (downstream) connection.",
+ "$ref": "#/definitions/request"
+ },
+ "proxy-request": {
+ "description": "Request sent by the proxy.",
+ "$ref": "#/definitions/request"
+ },
+ "server-response": {
+ "description": "Response from the outbound (upstream) connection.",
+ "$ref": "#/definitions/response"
+ },
+ "proxy-response": {
+ "description": "Response sent by the proxy.",
+ "$ref": "#/definitions/response"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+
+ "definitions": {
+ "encoding": {
+ "description": "Text encoding format.",
+ "type": "string",
+ "enum": ["plain", "uri", "esc_json"]
+ },
+ "content": {
+ "description": "HTTP payload.",
+ "anyOf" : [
+ {
+ "type": "object",
+ "description": "Explicit payload.",
+ "required": ["data"],
+ "properties": {
+ "encoding": {
+ "description": "Content data encoding for JSON compatibility.",
+ "$ref": "#/definitions/encoding"
+ },
+ "size": {
+ "description": "Size of the payload in bytes. This must match the actual size of the 'data' field.",
+ "type": "number"
+ },
+ "data": {
+ "description": "Content data.",
+ "type": "string"
+ }
+ }
+ },
+ {
+ "type": "object",
+ "description": "Synthesized payload (only size specified)",
+ "required": ["size"],
+ "properties": {
+ "encoding": {
+ "description": "Content data encoding for JSON compatibility.",
+ "$ref": "#/definitions/encoding"
+ },
+ "size": {
+ "description": "Size of the payload in bytes.",
+ "type": "number"
+ }
+ }
+ }
+ ]
+ },
+ "header-fields": {
+ "description": "HTTP header fields.",
+ "type": "object",
+ "required": ["fields"],
+ "properties": {
+ "encoding": {
+ "description": "Encoding applied to field values.",
+ "$ref": "#/definitions/encoding"
+ },
+ "fields": {
+ "description": "The field name and value pairs.",
+ "type": "array",
+ "items": {
+ "description": "HTTP field.",
+ "type": "array",
+ "items": [
+ {
+ "description": "Name of the field.",
+ "type": "string"
+ }, {
+ "description": "Value of the field.",
+ "type": "string"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "request": {
+ "title": "request",
+ "description": "HTTP request.",
+ "type": "object",
+ "required": [ "method", "url" ],
+ "properties": {
+ "version": {
+ "description": "HTTP version",
+ "type": "string",
+ "enum": ["0.9", "1.0", "1.1"]
+ },
+ "scheme": {
+ "description": "HTTP scheme (request).",
+ "type": "string"
+ },
+ "method": {
+ "description": "HTTP method (request)",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL path, anchor, and parameters.",
+ "type": "string"
+ },
+ "content": {
+ "description": "Payload for this request",
+ "$ref": "#/definitions/content"
+ },
+ "headers": {
+ "description": "HTTP header fields.",
+ "$ref": "#/definitions/header-fields"
+ }
+ }
+ },
+ "response": {
+ "title": "response",
+ "description": "HTTP response.",
+ "type": "object",
+ "required": ["status"],
+ "properties": {
+ "status": {
+ "description": "Status code.",
+ "type": "number"
+ },
+ "reason": {
+ "description": "Reason phrase.",
+ "type": "string"
+ },
+ "content": {
+ "description": "HTTP Payload",
+ "$ref": "#/definitions/content"
+ },
+ "headers": {
+ "description": "HTTP header fields.",
+ "$ref": "#/definitions/header-fields"
+ }
+ }
+ }
+ }
+}