Removed log constants (Azure#17729)

They should be defined in azcore/log, not here.
Added comments indicating which parts of log are public surface area.

Author: jhendrixMSFT

sdk/internal/CHANGELOG.md

@@ -1,10 +1,11 @@
 # Release History
 
-## 0.9.3 (Unreleased)
+## 0.10.0 (Unreleased)
 
 ### Features Added
 
 ### Breaking Changes
+* Removed logging constants from the `log` package.
 
 ### Bugs Fixed
 

sdk/internal/log/log.go

@@ -12,32 +12,13 @@ import (
 	"time"
 )
 
+///////////////////////////////////////////////////////////////////////////////////////////////////
+// NOTE: The following are exported as public surface area from azcore.  DO NOT MODIFY
+///////////////////////////////////////////////////////////////////////////////////////////////////
+
 // Event is used to group entries.  Each group can be toggled on or off.
 type Event string
 
-const (
-	// EventRequest entries contain information about HTTP requests.
-	// This includes information like the URL, query parameters, and headers.
-	EventRequest Event = "Request"
-
-	// EventResponse entries containe information about HTTP responses.
-	// This includes information like the HTTP status code, headers, and request URL.
-	EventResponse Event = "Response"
-
-	// EventRetryPolicy entries contain information specific to the rety policy in use.
-	EventRetryPolicy Event = "Retry"
-
-	// EventLRO entries contian information specific to long-running operations.
-	// This includes information like polling location, operation state, and sleep intervals.
-	EventLRO Event = "LongRunningOperation"
-)
-
-// logger controls which events to log and writing to the underlying log.
-type logger struct {
-	cls []Event
-	lst func(Event, string)
-}
-
 // SetEvents is used to control which events are written to
 // the log.  By default all log events are writen.
 func SetEvents(cls ...Event) {
@@ -49,6 +30,10 @@ func SetListener(lst func(Event, string)) {
 	log.lst = lst
 }
 
+///////////////////////////////////////////////////////////////////////////////////////////////////
+// END PUBLIC SURFACE AREA
+///////////////////////////////////////////////////////////////////////////////////////////////////
+
 // Should returns true if the specified log event should be written to the log.
 // By default all log events will be logged.  Call SetEvents() to limit
 // the log events for logging.
@@ -88,11 +73,17 @@ func Writef(cls Event, format string, a ...interface{}) {
 	log.lst(cls, fmt.Sprintf(format, a...))
 }
 
-// TestResetEvents is used for testing purposes only.
+// TestResetEvents is used for TESTING PURPOSES ONLY.
 func TestResetEvents() {
 	log.cls = nil
 }
 
+// logger controls which events to log and writing to the underlying log.
+type logger struct {
+	cls []Event
+	lst func(Event, string)
+}
+
 // the process-wide logger
 var log logger
 

sdk/internal/log/log_test.go

@@ -10,6 +10,11 @@ import (
 	"testing"
 )
 
+const (
+	EventRequest  Event = "Request"
+	EventResponse Event = "Response"
+)
+
 func TestLoggingdefault(t *testing.T) {
 	// ensure logging with nil listener doesn't fail
 	SetListener(nil)

sdk/internal/version.go

@@ -11,5 +11,5 @@ const (
 	Module = "internal"
 
 	// Version is the semantic version (see http://semver.org) of this module.
-	Version = "v0.9.3"
+	Version = "v0.10.0"
 )