ASP Core provides a built-in mechanism for configuration management. In brief, there is a number of configuration sources1, which are getting read in the order you specify, and the resulting "configuration" is a merged key-value dictionary.
A key in that dictionary is a string built from configuration sections concatenated with semicolon
:, for example
A value is the string, which may represent a number (
"10"), a boolean (
"true"), or anything else (
Configuration is built in the
Startup method and is available for Dependency Injection.
It is recommended to use configuration mechanism for static values (like label titles or constants). This way the values can easily be mocked for testing purposes.
It is required to supply
appsettings.yml file as a docker secret when deploying the application to Kubernetes.
Please, refer to Deployment section to download example config and supply it as docker secret.
appsettings.yml is a regular YAML file which follows YAML format constraints.
The following is the explanation of configuration settings.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
CompanyName: "Orange Inc." # Name of your company; appears on every page of the app Secrets: # This section needs to be overridden and kept in secret ApiKey: "SDKJF5432SMDFKL" # API Key to be used for API requests AdminPassword: "strong-password-987654" # Plain text password for administrator user ReCaptcha: # Settings for Google ReCaptcha (https://www.google.com/recaptcha/) Enabled: true # If false, ReCaptcha will not be displayed and checked SiteKey: "sdahjdjhd_678ajsdvbja" # Site key provided by Google SecretKey: "asgfdk_876ajhsvdjh" # Secret key provided by Google GoogleAnalytics: TrackingId: "UA-XXXXXXX-X" # Google Analytics tracking number (https://analytics.google.com) ConnectionString: "connection-strings" # Connection string to PostgreSQL database NOT INTENDED TO BE MODIFIED Email: # Email settings Enabled: true # If false, all messages sent to email service will be logged to STDOUT instead ToEmail: "firstname.lastname@example.org" # Email of the recipient FromTitle: "Status Notificator" # Title of sender FromEmail: "email@example.com" # Email of sender (also serves as login to SMTP server) Password: "smtp-password" # Password for SMTP server Host: "smtp.host.com" # Hostname / IP of SMTP server SMTP: # SMTP settings Port: 537 # SMTP port Security: "StartTls" # SMTP Security option (one of Auto, None, SslOnConnect, StartTls, StartTlsWhenAvailable) Slack: # Slack settings Enabled: true # If false, all messages sent to slack service will be logged to STDOUT instead WebHook: "https://slack.com/webhooks/a78" # Slack web hook URL which uniquely defines chanel (https://api.slack.com/incoming-webhooks) Data: # Static data put into DB during app initialization. Rarely override this section PingSettings: # Array of servers to ping - ServerUrl: "https://google.com" # URL to ping (FQDN required) MaxResponseTime: 2000 # The time after which to consider service unavailable, milliseconds MaxFailures: 3 # Allowed number of consecutive failures before call server dead GetMethodRequired: false # If true, HTTP GET method will be used to ping, HTTP HEAD otherwise Logging: # This section (except "LogSeverityReported") refers to status site own internal logging as an application (not API logging) MinLogLevel: "Information" # Minimal log level of status site itself to send to STDOUT LogSeverityReported: "Error" # Minimal log entry severity to notify user about Exclude # Array of strings which - if contained in the status site log source - to ignore - "Microsoft." # Example of such string. All messages from "Microsoft" are ignored Guard: # This section defines protection settings for some API endpoints Logging: # Protection of /api/logmessage endpoint from SPAMing Requests: 10 # Number of requests to allow from a single source and category per time frame PerSeconds: 10 # Time frame in seconds ServiceManager: # Settings for daemon part of the app CacheService: # Settings for cache service of the app Enabled: true # Whether to use the service Interval: 30 # How many seconds to wait between re-runs of the service CleanService: # Settings for clean service of the app Enabled: true # Whether to use the service Interval: 900 # How many seconds to wait between re-runs of the service MaxAge: 18000 # A number of seconds that defines a maximum age of data points and log entries before they are cleaned by the service PingService: # Settings for ping service of the app Enabled: true # Whether to use the service Interval: 60 # How many seconds to wait between re-runs of the service PingService: # Settings for health service of the app Enabled: true # Whether to use the service Interval: 60 # How many seconds to wait between re-runs of the service DemoService: # Settings for demo service of the app Enabled: true # Whether to use the service Interval: 30 # How many seconds to wait between re-runs of the service Gaps: # Demo service may generate gaps in data Enabled: true # If true, then the gaps in data will be periodically generated Frequency: 10 # N, where once in N runs a gap is generated DiscrepancyService: # Settings for discrepancy service of the app Enabled: true # Whether to use the service Interval: 60 # How many seconds to wait between re-runs of the service DataTimeFrame: 800 # Number of seconds of data to consider counting from the time of running the service when looking for discrepancies Gaps: # Settings for type of discrepancy "Gap in data" MaxDifference: 60 # Number of seconds multiplied by 1.5 to consider as gap Load: # Settings for type of discrepancy "High load" Threshold: 90 # From which load to consider server high-loaded (only CPU Load metrics) MaxFailures: 6 # Max allowed number of consecutive high loads before it gets reported NotificationService: # Settings for notification service of the app Enabled: true # Whether to use the service Interval: 20 # How many seconds to wait between re-runs of the service Verbosity: "normal" # How verbose the messages should be. "normal" will include grouping by severity and greetings. "less" will include messages, their timestamps and number of outstanding issues only. TimeZone: "America/New_York" # Preferred time zone for displaying dates and times in notifications Frequencies: # Number of seconds to wait before sending out notifications of given severity Low: 86400 # Example: notifications of low severity will be sent no more than once in 86400 seconds Medium: 360 # Example: notifications of medium severity will be sent no more than once in 360 seconds High: 60 # Example: notifications of high severity will be sent no more than once in 60 seconds
Here are the helpful links:
From MS Docs:
There are configuration providers for:
- File formats (INI, JSON, and XML)
- Command-line arguments
- Environment variables
- In-memory .NET objects
- An encrypted user store
- Azure Key Vault
- Custom providers, which you install or create