1. <?php
  3. /**
  4. * API Payload Metrics Collector for Sandbox
  5. *
  6. * Collects metrics (size, headers, content type, errors) of API payloads
  7. * for sandbox usage with simple error messages.
  8. */
  10. class ApiMetricsCollector {
  12. /**
  13. * @param string $url The API endpoint URL.
  14. * @param array $headers Optional headers to send with the request.
  15. * @param array $data Optional data to send with the request (for POST/PUT).
  16. * @return array An associative array containing metrics and errors.
  17. */
  18. public function collectMetrics(string $url, array $headers = [], array $data = []): array {
  20. $metrics = [];
  21. $errors = [];
  23. try {
  24. // Simulate API request (replace with actual API client)
  25. $response = $this->simulateApiRequest($url, $headers, $data);
  27. if ($response === false) {
  28. $errors[] = "API request failed: " . $this->getApiError();
  29. return [
  30. 'size' => null,
  31. 'headers' => null,
  32. 'content_type' => null,
  33. 'errors' => $errors,
  34. ];
  35. }
  37. $metrics['size'] = strlen($response); // Payload size in bytes
  39. $metrics['headers'] = $this->parseHeaders($response);
  41. $metrics['content_type'] = $this->getContentType($response);
  43. } catch (Exception $e) {
  44. $errors[] = "An unexpected error occurred: " . $e->getMessage();
  45. }
  47. return [
  48. 'size' => $metrics['size'],
  49. 'headers' => $metrics['headers'],
  50. 'content_type' => $metrics['content_type'],
  51. 'errors' => $errors,
  52. ];
  53. }
  55. /**
  56. * Simulates an API request. Replace with a real API client (e.g., cURL, Guzzle).
  57. * @param string $url
  58. * @param array $headers
  59. * @param array $data
  60. * @return string|false
  61. */
  62. private function simulateApiRequest(string $url, array $headers = [], array $data = []): string|false {
  63. // Simplified simulation - replace with real API call
  64. if ($url === 'https://example.com/api/data') {
  65. return "This is some sample data.";
  66. } elseif ($url === 'https://example.com/api/error') {
  67. return false; // Simulate an error
  68. } else {
  69. return "Simulated response for: " . $url;
  70. }
  71. }
  73. /**
  74. * Parses headers from the API response.
  75. * @param string $response
  76. * @return array
  77. */
  78. private function parseHeaders(string $response): array {
  79. $headers = [];
  80. $lines = explode("\n", $response);
  81. foreach ($lines as $line) {
  82. if (strpos($line, ':') !== false) {
  83. list($key, $value) = explode(': ', $line, 2); // Split into key and value
  84. $headers[$key] = trim($value);
  85. }
  86. }
  87. return $headers;
  88. }
  90. /**
  91. * Determines the content type of the response.
  92. * @param string $response
  93. * @return string|null
  94. */
  95. private function getContentType(string $response): ?string {
  96. $lines = explode("\n", $response);
  97. foreach ($lines as $line) {
  98. if (strpos($line, 'Content-Type:') !== false) {
  99. return trim(substr($line, strpos($line, ':') + 2));
  100. }
  101. }
  102. return null;
  103. }
  105. /**
  106. * Returns a generic error message.
  107. * @return string
  108. */
  109. private function getApiError(): string {
  110. return "API returned an error.";
  111. }
  112. }
  116. // Example Usage:
  117. $collector = new ApiMetricsCollector();
  119. $metrics = $collector->collectMetrics('https://example.com/api/data');
  121. echo "Metrics:\n";
  122. print_r($metrics);
  124. $metrics = $collector->collectMetrics('https://example.com/api/error');
  126. echo "\nMetrics with error:\n";
  127. print_r($metrics);
  130. ?>

Add your comment