Implement optional name and description on http stream handlers so that we can relate a slow request to what the handler actually does and the agent it serves, if applicable.

This is most useful for capabilities where the url is not self-describing.

9 files changed, 88 insertions, 35 deletions

diff --git a/OpenSim/Framework/Servers/HttpServer/BaseHTTPHandler.cs b/OpenSim/Framework/Servers/HttpServer/BaseHTTPHandler.cs
index 2fe9769..9f8f4a8 100644
--- a/OpenSim/Framework/Servers/HttpServer/BaseHTTPHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/BaseHTTPHandler.cs
@@ -33,9 +33,9 @@ namespace OpenSim.Framework.Servers.HttpServer
     {
         public abstract Hashtable Handle(string path, Hashtable Request);
 
-        protected BaseHTTPHandler(string httpMethod, string path)
-            : base(httpMethod, path)
-        {
-        }
+        protected BaseHTTPHandler(string httpMethod, string path) : this(httpMethod, path, null, null) {}
+
+        protected BaseHTTPHandler(string httpMethod, string path, string name, string description)
+            : base(httpMethod, path, name, description) {}
     }
-}
+}
\ No newline at end of file
diff --git a/OpenSim/Framework/Servers/HttpServer/BaseHttpServer.cs b/OpenSim/Framework/Servers/HttpServer/BaseHttpServer.cs
index 0fbf90a..4ea4a1a 100644
--- a/OpenSim/Framework/Servers/HttpServer/BaseHttpServer.cs
+++ b/OpenSim/Framework/Servers/HttpServer/BaseHttpServer.cs
@@ -156,7 +156,7 @@ namespace OpenSim.Framework.Servers.HttpServer
             }
         }
 
-        public List<string>  GetStreamHandlerKeys()
+        public List<string> GetStreamHandlerKeys()
         {
             lock (m_streamHandlers)
                 return new List<string>(m_streamHandlers.Keys);
@@ -410,6 +410,8 @@ namespace OpenSim.Framework.Servers.HttpServer
 //            string reqnum = "unknown";
             int tickstart = Environment.TickCount;
 
+            IRequestHandler requestHandler = null;
+
             try
             {
                 // OpenSim.Framework.WebUtil.OSHeaderRequestID
@@ -438,8 +440,6 @@ namespace OpenSim.Framework.Servers.HttpServer
                 //response.KeepAlive = true;
                 response.SendChunked = false;
 
-                IRequestHandler requestHandler;
-
                 string path = request.RawUrl;
                 string handlerKey = GetHandlerKey(request.HttpMethod, path);
 
@@ -675,8 +675,16 @@ namespace OpenSim.Framework.Servers.HttpServer
                 // since its just for reporting, tickdiff limit can be adjusted
                 int tickdiff = Environment.TickCount - tickstart;
                 if (tickdiff > 3000)
+                {
                     m_log.InfoFormat(
-                        "[BASE HTTP SERVER]: slow {0} request for {1} from {2} took {3} ms", requestMethod, uriString, request.RemoteIPEndPoint.ToString(), tickdiff);
+                        "[BASE HTTP SERVER]: slow {0} for {1} {2} {3} from {4} took {5} ms",
+                        requestMethod,
+                        uriString,
+                        requestHandler != null ? requestHandler.Name : "",
+                        requestHandler != null ? requestHandler.Description : "",
+                        request.RemoteIPEndPoint.ToString(),
+                        tickdiff);
+                }
             }
         }
 
diff --git a/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs b/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs
index a2135a3..ae7aaf2 100644
--- a/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/BaseRequestHandler.cs
@@ -45,8 +45,16 @@ namespace OpenSim.Framework.Servers.HttpServer
 
         private readonly string m_path;
 
-        protected BaseRequestHandler(string httpMethod, string path)
+        public string Name { get; private set; }
+
+        public string Description { get; private set; }
+
+        protected BaseRequestHandler(string httpMethod, string path) : this(httpMethod, path, null, null) {}
+
+        protected BaseRequestHandler(string httpMethod, string path, string name, string description)
         {
+            Name = name;
+            Description = description;
             m_httpMethod = httpMethod;
             m_path = path;
         }
diff --git a/OpenSim/Framework/Servers/HttpServer/BaseStreamHandler.cs b/OpenSim/Framework/Servers/HttpServer/BaseStreamHandler.cs
index f1cde74..6342983 100644
--- a/OpenSim/Framework/Servers/HttpServer/BaseStreamHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/BaseStreamHandler.cs
@@ -34,8 +34,9 @@ namespace OpenSim.Framework.Servers.HttpServer
         public abstract byte[] Handle(string path, Stream request,
                                       IOSHttpRequest httpRequest, IOSHttpResponse httpResponse);
 
-        protected BaseStreamHandler(string httpMethod, string path) : base(httpMethod, path)
-        {
-        }
+        protected BaseStreamHandler(string httpMethod, string path) : this(httpMethod, path, null, null) {}
+
+        protected BaseStreamHandler(string httpMethod, string path, string name, string description)
+            : base(httpMethod, path, name, description) {}
     }
-}
+}
\ No newline at end of file
diff --git a/OpenSim/Framework/Servers/HttpServer/BinaryStreamHandler.cs b/OpenSim/Framework/Servers/HttpServer/BinaryStreamHandler.cs
index 1699233..b94bfb4 100644
--- a/OpenSim/Framework/Servers/HttpServer/BinaryStreamHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/BinaryStreamHandler.cs
@@ -36,6 +36,15 @@ namespace OpenSim.Framework.Servers.HttpServer
     {
         private BinaryMethod m_method;
 
+        public BinaryStreamHandler(string httpMethod, string path, BinaryMethod binaryMethod)
+            : this(httpMethod, path, binaryMethod, null, null) {}
+
+        public BinaryStreamHandler(string httpMethod, string path, BinaryMethod binaryMethod, string name, string description)
+            : base(httpMethod, path, name, description)
+        {
+            m_method = binaryMethod;
+        }
+
         public override byte[] Handle(string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
         {
             byte[] data = ReadFully(request);
@@ -45,12 +54,6 @@ namespace OpenSim.Framework.Servers.HttpServer
             return Encoding.UTF8.GetBytes(responseString);
         }
 
-        public BinaryStreamHandler(string httpMethod, string path, BinaryMethod binaryMethod)
-            : base(httpMethod, path)
-        {
-            m_method = binaryMethod;
-        }
-
         private static byte[] ReadFully(Stream stream)
         {
             byte[] buffer = new byte[1024];
@@ -70,4 +73,4 @@ namespace OpenSim.Framework.Servers.HttpServer
             }
         }
     }
-}
+}
\ No newline at end of file
diff --git a/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs b/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs
index a449c2d..cb5cce5 100644
--- a/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/Interfaces/IStreamHandler.cs
@@ -32,6 +32,25 @@ namespace OpenSim.Framework.Servers.HttpServer
 {
     public interface IRequestHandler
     {
+
+        /// <summary>
+        /// Name for this handler.
+        /// </summary>
+        /// <remarks>
+        /// Used for diagnostics.  The path doesn't always describe what the handler does.  Can be null if none
+        /// specified.
+        /// </remarks>
+        string Name { get; }
+
+        /// <summary>
+        /// Description for this handler.
+        /// </summary>
+        /// <remarks>
+        /// Used for diagnostics.  The path doesn't always describe what the handler does.  Can be null if none
+        /// specified.
+        /// </remarks>
+        string Description { get; }
+
         // Return response content type
         string ContentType { get; }
 
@@ -58,4 +77,4 @@ namespace OpenSim.Framework.Servers.HttpServer
     {
         Hashtable Handle(string path, Hashtable request);
     }
-}
+}
\ No newline at end of file
diff --git a/OpenSim/Framework/Servers/HttpServer/RestDeserialiseHandler.cs b/OpenSim/Framework/Servers/HttpServer/RestDeserialiseHandler.cs
index a467a83..07082a8 100644
--- a/OpenSim/Framework/Servers/HttpServer/RestDeserialiseHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/RestDeserialiseHandler.cs
@@ -39,7 +39,11 @@ namespace OpenSim.Framework.Servers.HttpServer
         private RestDeserialiseMethod<TRequest, TResponse> m_method;
 
         public RestDeserialiseHandler(string httpMethod, string path, RestDeserialiseMethod<TRequest, TResponse> method)
-            : base(httpMethod, path)
+            : this(httpMethod, path, method, null, null) {}
+
+        public RestDeserialiseHandler(
+            string httpMethod, string path, RestDeserialiseMethod<TRequest, TResponse> method, string name, string description)
+            : base(httpMethod, path, name, description)
         {
             m_method = method;
         }
diff --git a/OpenSim/Framework/Servers/HttpServer/RestHTTPHandler.cs b/OpenSim/Framework/Servers/HttpServer/RestHTTPHandler.cs
index 1f23cac..7f89839 100644
--- a/OpenSim/Framework/Servers/HttpServer/RestHTTPHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/RestHTTPHandler.cs
@@ -38,19 +38,25 @@ namespace OpenSim.Framework.Servers.HttpServer
             get { return m_dhttpMethod; }
         }
 
-        public override Hashtable Handle(string path, Hashtable request)
+        public RestHTTPHandler(string httpMethod, string path, GenericHTTPMethod dhttpMethod)
+            : base(httpMethod, path)
         {
+            m_dhttpMethod = dhttpMethod;
+        }
+
+        public RestHTTPHandler(
+            string httpMethod, string path, GenericHTTPMethod dhttpMethod, string name, string description)
+            : base(httpMethod, path, name, description)
+        {
+            m_dhttpMethod = dhttpMethod;
+        }
 
+        public override Hashtable Handle(string path, Hashtable request)
+        {
             string param = GetParam(path);
             request.Add("param", param);
             request.Add("path", path);
             return m_dhttpMethod(request);
         }
-
-        public RestHTTPHandler(string httpMethod, string path, GenericHTTPMethod dhttpMethod)
-            : base(httpMethod, path)
-        {
-            m_dhttpMethod = dhttpMethod;
-        }
     }
 }
diff --git a/OpenSim/Framework/Servers/HttpServer/RestStreamHandler.cs b/OpenSim/Framework/Servers/HttpServer/RestStreamHandler.cs
index d2c4002..1f17fee 100644
--- a/OpenSim/Framework/Servers/HttpServer/RestStreamHandler.cs
+++ b/OpenSim/Framework/Servers/HttpServer/RestStreamHandler.cs
@@ -39,6 +39,15 @@ namespace OpenSim.Framework.Servers.HttpServer
             get { return m_restMethod; }
         }
 
+        public RestStreamHandler(string httpMethod, string path, RestMethod restMethod)
+            : this(httpMethod, path, restMethod, null, null) {}
+
+        public RestStreamHandler(string httpMethod, string path, RestMethod restMethod, string name, string description)
+            : base(httpMethod, path, name, description)
+        {
+            m_restMethod = restMethod;
+        }
+
         public override byte[] Handle(string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
         {
             Encoding encoding = Encoding.UTF8;
@@ -52,10 +61,5 @@ namespace OpenSim.Framework.Servers.HttpServer
 
             return Encoding.UTF8.GetBytes(responseString);
         }
-
-        public RestStreamHandler(string httpMethod, string path, RestMethod restMethod) : base(httpMethod, path)
-        {
-            m_restMethod = restMethod;
-        }
     }
 }