1. <?php
  3. /**
  4. * Header Metadata Instrumentation
  5. *
  6. * This function instruments the headers metadata of a local utility
  7. * with synchronous execution. It adds a tracing mechanism to log
  8. * header information during the execution of the utility.
  9. *
  10. * @param callable $utility_function The callable (function) to instrument.
  11. * @param string $log_file (optional) The file to log header metadata to. Defaults to 'header_log.txt'.
  12. * @return callable The instrumented function.
  13. */
  14. function instrumentHeaders(callable $utility_function, string $log_file = 'header_log.txt'): callable
  15. {
  16. // Define a function to log header metadata
  17. $log_header_metadata = function () use ($log_file) {
  18. $headers = getallheaders();
  19. if ($headers) {
  20. $log_string = "--- Header Metadata ---\n";
  21. foreach ($headers as $header => $value) {
  22. $log_string .= "$header: $value\n";
  23. }
  24. $log_string .= "--- End Header Metadata ---\n";
  26. // Write to log file
  27. file_put_contents($log_file, $log_string, FILE_APPEND);
  28. } else {
  29. $log_string = "--- No Headers Found ---\n";
  30. file_put_contents($log_file, $log_string, FILE_APPEND);
  31. }
  32. };
  34. // Wrap the utility function
  35. return function () use ($utility_function, $log_header_metadata) {
  36. // Log header metadata before execution
  37. $log_header_metadata();
  39. // Execute the original utility function
  40. $utility_function();
  42. // Log header metadata after execution
  43. $log_header_metadata();
  44. };
  45. }
  47. // Example Usage (for testing):
  48. /*
  49. function myUtilityFunction() {
  50. // Simulate some work
  51. sleep(1);
  52. header('Content-Type: application/json');
  53. echo json_encode(['message' => 'Utility executed']);
  54. }
  56. $instrumentedFunction = instrumentHeaders('myUtilityFunction', 'my_header_log.txt');
  57. $instrumentedFunction(); // Execute the instrumented function
  58. */
  60. ?>

Add your comment