Allows for resizing librecords via command line option

This also eliminates the old configure option --with-max-api-stats. Rather,
you should set the full size of the entire librecords with this setting, with
~1100 needed for the core, and (recommended) 500 for metrics as a minimum.
That is the default (1600) unless specified.

The reason this has to be a command line is because librecords can not be
initialized without it, hence, it can not be a records.config setting.

Author: zwoop

doc/appendices/command-line/traffic_manager.en.rst

@@ -40,6 +40,7 @@ Description
 .. option:: --proxyPort PORT
 .. option:: --recordsConf FILE
 .. option:: --tsArgs ARGUMENTS
+.. option:: --maxRecords RECORDS
 .. option:: --version
 
 Signals

doc/appendices/command-line/traffic_server.en.rst

@@ -83,6 +83,8 @@ the available tests.
 
 .. option:: -t MSECS, --poll_timeout MSECS
 
+.. option:: -m RECORDS, --maxRecords RECORDS
+
 .. option:: -h, --help
 
    Print usage information and exit.

include/tscore/ink_config.h.in

@@ -92,8 +92,6 @@
 
 #define TS_MAX_HOST_NAME_LEN @max_host_name_len@
 
-#define TS_MAX_API_STATS @max_api_stats@
-
 #define SPLIT_DNS 1
 
 /* Defaults for user / group */

lib/records/P_RecDefs.h

@@ -31,10 +31,11 @@
 
 #define REC_MESSAGE_ELE_MAGIC 0xF00DF00D
 
-// This is for the internal stats and configs, as well as API stats. We currently use
-// about 1600 stats + configs for the core, but we're allocating 2000 for some growth.
-// TODO: if/when we switch to a new config system, we should make this run-time dynamic.
-#define REC_MAX_RECORDS (2000 + TS_MAX_API_STATS)
+// We need at least this many internal record entries for our configurations and metrics. Any
+// additional slots in librecords will be allocated to the plugin metrics. These should be
+// updated if we change the internal librecords size significantly.
+#define REC_INTERNAL_RECORDS 1100
+#define REC_MIN_API_RECORDS 500
 
 #define REC_CONFIG_UPDATE_INTERVAL_MS 3000
 #define REC_REMOTE_SYNC_INTERVAL_MS 5000

lib/records/RecCore.cc

@@ -25,11 +25,16 @@
 #include "tscore/ink_memory.h"
 #include "tscore/ink_string.h"
 
+#include "RecordsConfig.h"
 #include "P_RecFile.h"
 #include "P_RecCore.h"
 #include "P_RecUtils.h"
 #include "tscore/I_Layout.h"
 
+// This is needed to manage the size of the librecords record. It can't be static, because it needs to be modified
+// and used (read) from several binaries / modules.
+int max_records_entries = REC_INTERNAL_RECORDS + REC_MIN_API_RECORDS;
+
 static bool g_initialized = false;
 
 RecRecord *g_records = nullptr;
@@ -197,7 +202,7 @@ RecCoreInit(RecModeT mode_type, Diags *_diags)
   g_num_records = 0;
 
   // initialize record array for our internal stats (this can be reallocated later)
-  g_records = (RecRecord *)ats_malloc(REC_MAX_RECORDS * sizeof(RecRecord));
+  g_records = (RecRecord *)ats_malloc(max_records_entries * sizeof(RecRecord));
 
   // initialize record rwlock
   ink_rwlock_init(&g_records_rwlock);

lib/records/RecUtils.cc

@@ -24,6 +24,7 @@
 #include "tscore/ink_platform.h"
 #include "tscore/ink_memory.h"
 #include "tscore/ParseRules.h"
+#include "RecordsConfig.h"
 #include "P_RecUtils.h"
 #include "P_RecCore.h"
 
@@ -49,8 +50,8 @@ RecRecordFree(RecRecord *r)
 RecRecord *
 RecAlloc(RecT rec_type, const char *name, RecDataT data_type)
 {
-  if (g_num_records >= REC_MAX_RECORDS) {
-    Warning("too many stats/configs, please increase REC_MAX_RECORDS or rebuild with --with_max_api_stats=<n>");
+  if (g_num_records >= max_records_entries) {
+    Warning("too many stats/configs, please increase max_records_entries using the --maxRecords command line option");
     return nullptr;
   }
 

mgmt/RecordsConfig.h

@@ -25,6 +25,9 @@
 
 #include "records/P_RecCore.h"
 
+// This is to manage the librecords table sizes. Not awesome, but better than the earlier recompiling of ATS requirement...
+extern int max_records_entries;
+
 enum RecordRequiredType {
   RR_NULL,    // config is _not_ required to be defined in records.config
   RR_REQUIRED // config _is_ required to be defined in record.config

mgmt/api/CoreAPI.cc

@@ -28,10 +28,12 @@
  *
  *
  ***************************************************************************/
+#include <vector>
 
 #include "tscore/ink_platform.h"
 #include "tscore/ink_file.h"
 #include "tscore/ParseRules.h"
+#include "RecordsConfig.h"
 #include "Alarms.h"
 #include "MgmtUtils.h"
 #include "LocalManager.h"
@@ -47,8 +49,6 @@
 #include "tscore/I_Layout.h"
 #include "tscore/ink_cap.h"
 
-#include <vector>
-
 // global variable
 static CallbackTable *local_event_callbacks;
 
@@ -170,7 +170,11 @@ ProxyStateSet(TSProxyStateT state, TSCacheClearT clear)
 
     // Start with the default options from records.config.
     if (RecGetRecordString_Xmalloc("proxy.config.proxy_binary_opts", &proxy_options) == REC_ERR_OKAY) {
-      snprintf(tsArgs, sizeof(tsArgs), "%s", proxy_options);
+      if (max_records_entries == (REC_INTERNAL_RECORDS + REC_MIN_API_RECORDS)) { // Default size, don't need to pass down to _server
+        snprintf(tsArgs, sizeof(tsArgs), "%s", proxy_options);
+      } else {
+        snprintf(tsArgs, sizeof(tsArgs), "%s --maxRecords %d", proxy_options, max_records_entries);
+      }
       ats_free(proxy_options);
     }
 

plugins/experimental/remap_stats/remap_stats.c

@@ -42,6 +42,9 @@ typedef struct {
   TSMutex stat_creation_mutex;
 } config_t;
 
+// From "core".... sigh, but we need it for now at least.
+extern int max_records_entries;
+
 static void
 stat_add(char *name, TSMgmtInt amount, TSStatPersistence persist_type, TSMutex create_mutex)
 {
@@ -52,7 +55,7 @@ stat_add(char *name, TSMgmtInt amount, TSStatPersistence persist_type, TSMutex c
 
   if (unlikely(!hash_init)) {
     // NOLINTNEXTLINE
-    hcreate_r(TS_MAX_API_STATS << 1, &stat_cache);
+    hcreate_r(max_records_entries << 1, &stat_cache); // This is weird, but oh well.
     hash_init = true;
     TSDebug(DEBUG_TAG, "stat cache hash init");
   }

src/traffic_layout/info.cc

@@ -116,7 +116,6 @@ produce_features(bool json)
   print_feature("TS_MAX_THREADS_IN_EACH_THREAD_TYPE", TS_MAX_THREADS_IN_EACH_THREAD_TYPE, json);
   print_feature("TS_MAX_NUMBER_EVENT_THREADS", TS_MAX_NUMBER_EVENT_THREADS, json);
   print_feature("TS_MAX_HOST_NAME_LEN", TS_MAX_HOST_NAME_LEN, json);
-  print_feature("TS_MAX_API_STATS", TS_MAX_API_STATS, json);
   print_feature("SPLIT_DNS", SPLIT_DNS, json);
   print_feature("TS_PKGSYSUSER", TS_PKGSYSUSER, json);
   print_feature("TS_PKGSYSGROUP", TS_PKGSYSGROUP, json, true);