Changes between Version 7 and Version 8 of MapGuideRfc110

Timestamp:

04/21/11 23:06:30 (14 years ago)

Author:

liuar

Comment:

--

MapGuideRfc110

@@ -24 +24 @@
 == Overview ==
 
-This RFC adds some profiling APIs to !MapGuide to help identify resources that need to be optimized and performance bottlenecks.
+This RFC adds an !MgProfilingService which provides some profiling APIs to !MapGuide to help identify resources that need to be optimized and performance bottlenecks.
 
 == Motivation ==
@@ -43 +43 @@
                                MgColor* backgroundColor,
                                CREFSTRING format,
-                               bool bKeepSelection,
-                               INT32 runs);
+                               bool bKeepSelection);
 }}}
 
@@ -51 +50 @@
 MgByteReader* ProfileRenderDynamicOverlay(MgMap* map,
                                           MgSelection* selection,
-                                          MgRenderingOptions* options,
-                                          INT32 runs);
+                                          MgRenderingOptions* options);
 }}}
 
@@ -60 +58 @@
                                      INT32 height,
                                      MgColor* backgroundColor,
-                                     CREFSTRING format,
-                                     INT32 runs);
-}}}
-
-{{{
-MgByteReader* ProfileResource(MgResourceIdentifier* resource, INT32 runs)
+                                     CREFSTRING format);
+}}}
+
+{{{
+MgByteReader* ProfileResource(MgResourceIdentifier* resource)
 }}}
 
@@ -85 +82 @@
 !MapDefinition:
 {{{
+Resource Id
+Coordinate System
+Extents
+Layer Count
+Watermark Count
+Image Format
+Render Map Time
+Render Layers Time
+Render Selection Time
+Render Watermars Time
+Render Labels Time
+Create Image Time
+}}}
+
+!LayerDefinition:
+{{{
+Resource Id
+Schema Name
+Feature Class Name
+Scale Ranges
+Coordinate System
+Filter
+Number of Features
 Render Time
-Initial scale ranges
-Initial layers
-Base layers
-Coordinate System
-Legend details
-Data extents
-}}}
-
-!LayerDefinition:
-{{{
-Render Time
-Query Time
-Number of Features
-Feature Class
-Properties
-Data Extents
-Filters
-Scale Ranges
-Theme Rules
-Tooltip
-URL
-Watermark (If applicable)
+Get Idendity Properties Time
+Coordinate System Transform Time (Only applies if we are profiling a map rendering process.)
+Query Features Time
+Stylization Time
 }}}
 
 !FeatureSource:
 {{{
-Initial FDO Connection Time
-Subsequent FDO Connection Time (Cache hits)
-Initial DescribeSchema Time
-Subsequent DescribeSchema Time (Cache hits)
-Remaining cached FDO information 
+Resource Id
+Provider Time
+IsFromCache
 Joins
 Calculations
-Coordinate System of Data (Indicate if a CS transformation is needed. Only applies if we are profiling a map.)
-}}}
+Open Connection Time
+Describe Schemas Time
+SelectFeatures Time
+}}}
+
+!WatermarkDefinition
+{{{
+Resource Id
+Position Type
+Stylization Time
+}}}
+
+Labels:
+{{{
+Label Count
+Render Labels Time
+}}}
+
 
 == XML Report / Schema ==
@@ -128 +144 @@
 '''TBD XML document schema'''
 
-Example of profiling a !MapDefintion: (Work in progress)
-{{{
-Map Summary
-  Layer(s) Summary
-  Layer(s) Details 
-    Feature Source(s) Summary
-    Feature Source(s) Details
+Example of profiling rendering map process: (Work in progress)
+{{{
+-MapProfileResult
+  -Map Summary
+    Resource Id
+    Resource Id
+    Coordinate System
+    Extents
+    Layer Count
+    Watermark Count
+    Image Format
+    Render Map Time
+    Render Layers Time
+    Render Selection Time
+    Render Watermars Time
+    Render Labels Time
+    Create Image Time
+  -Map Details
+    -LayerProfileResult
+      -Layer(s) Summary
+        Resource Id
+        Schema Name
+        Feature Class Name
+        Scale Ranges
+        Coordinate System
+        Filter
+        Number of Features
+        Render Time
+        Get Idendity Properties Time
+        Coordinate System Transform Time (Only applies if we are profiling a map rendering process.)
+        Query Features Time
+        Stylization Time
+      -Layer(s) Details 
+        +Feature Source(s) Summary
+        +Feature Source(s) Details
+    -SelectionProfileResult
+      Layer(s) Summary
+      Layer(s) Details 
+    -WatermarkProfileResult
+      -Watermark(s) Summary
+        Resource Id
+        Position Type
+        Stylization Time
+      +Watermark(s) Details
+    -LabelsProfileResult
+      -Labels Summary
+        Label Count
+        Render Labels Time
+
 }}}
 
 == Implications ==
 
-None as these are new APIs.
+Solution 1.
+Copy the implementation of profiling related APIs to !MgServerProfilingService and add profiling code into the copied version, for example, copy the implementation of !RenderMap in !MgServerRenderingService(and all other MG server APIs invoked in !RenderMap) to !MgServerProfilingService. The advantage and disadvantage of this implementation is obvious: less influence on the origial implementation but heavy maintainence to do in the future.
+
+Solution 2.
+Inject the profiling code into the functions being profiled, which means !MgServerServices should be extended to accept a !ProfileResult and the implementation of some APIs will updated to support profiling. For example, to support profiling !RenderMap, all the !MgServerServices in the !RenderMap workflow will be affected - !MgServerRenderingService, !MgServerResourceService, !MgServerFeatureService, !MgServerDescribeSchema, !MgServerSelectFeatures, etc.
+
+For both solustions, how many code should be copied or updated will be decided by how detailed information should be gathered.
 
 == Test Plan ==