Log Search Configurations

NameDescriptionDefaultExamples
hadoop.security.credential.provider.pathPath to interrogate for protected credentials. (see: https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/CredentialProviderAPI.html)EMPTYlocaljceks://file/home/mypath/my.jceks
logsearch.admin.kerberos.cookie.domainDomain for Kerberos cookie.localhostc6401.ambari.apache.orglocalhost
logsearch.admin.kerberos.cookie.pathCookie path of the kerberos cookie//
logsearch.admin.kerberos.token.valid.secondsKerberos token validity in seconds.3030
logsearch.auth.external_auth.enabledEnable external authentication (currently Ambari acts as an external authentication server).falsetruefalse
logsearch.auth.external_auth.host_urlExternal authentication server URL (host and port).http://ip:porthttps://c6401.ambari.apache.org:8080
logsearch.auth.external_auth.login_urlLogin URL for external authentication server ($USERNAME parameter is replaced with the Login username)./api/v1/users/$USERNAME/privileges?fields=*/api/v1/users/$USERNAME/privileges?fields=*
logsearch.auth.file.enabledEnable file based authentication (in json file at logsearch configuration folder).truetruefalse
logsearch.auth.jwt.audiancesComma separated list of acceptable audiences for the JWT token.EMPTYaudiance1,audiance2
logsearch.auth.jwt.cookie.nameThe name of the cookie that contains the JWT token.hadoop-jwthadoop-jwt
logsearch.auth.jwt.enabledEnable JWT based authentication (e.g.: for KNOX).falsetruefalse
logsearch.auth.jwt.provider_urlURL to the JWT authentication server.EMPTYhttps://c6401.ambari.apache.org:8443/mypath
logsearch.auth.jwt.public_keyPEM formatted public key for JWT token without the header and the footer.EMPTYMIGfMA0GCSqGSIb3DQEBA...
logsearch.auth.jwt.query.param.original_urlName of the original request URL which is used to redirect to Log Search Portal.originalUrlmyUrl
logsearch.auth.jwt.user.agentsComma separated web user agent list. (Used as prefixes)Mozilla,Opera,ChromeMozilla,Chrome
logsearch.auth.ldap.base.dnBase DN of LDAP database.EMPTYdc=apache,dc=org
logsearch.auth.ldap.enabledEnable LDAP based authentication (currenty not supported).falsetruefalse
logsearch.auth.ldap.group.role.attributeAttribute for identifying LDAP groups (group name)cncn
logsearch.auth.ldap.group.role.mapMap of LDAP groups to Log Search rolesEMPTYROLE_CUSTOM1:ROLE_USER,ROLE_CUSTOM2:ROLE_ADMIN
logsearch.auth.ldap.group.search.baseGroup search base - defines where to find LDAP groups. Won't do any authority/role mapping if this field is empty.EMPTYou=people
logsearch.auth.ldap.group.search.filterGroup search filter which is used to get membership data for a specific userEMPTY(memberUid={0})
logsearch.auth.ldap.manager.dnDN of the LDAP manger user (it is a must if LDAP groups are used).EMPTYcn=admin,dc=apache,dc=org
logsearch.auth.ldap.manager.passwordPassword of the LDAP manager user.EMPTYmypassword
logsearch.auth.ldap.manager.password.fileFile that contains password of the LDAP manager user.EMPTY/my/path/passwordfile
logsearch.auth.ldap.password.attributePassword attribute for LDAP authenticationuserPasswordpassword
logsearch.auth.ldap.referral.methodSet the method to handle referrals for LDAPignorefollow
logsearch.auth.ldap.role.prefixRole prefix that is added for LDAP groups (as authorities)ROLE_ROLE_
logsearch.auth.ldap.urlURL of LDAP database.EMPTYldap://localhost:389
logsearch.auth.ldap.user.dn.patternDN pattern that is used during login (dn should contain the username), can be used instead of user filterEMPTYuid={0},ou=people
logsearch.auth.ldap.user.search.baseUser search base for user search filterEMPTYou=people
logsearch.auth.ldap.user.search.filterUsed for get a user based on on LDAP search (username is the input), if it is empty, user dn pattern is used.EMPTYuid={0}
logsearch.auth.proxyserver.ipIP of trusted Knox Proxy server(s) that Log Search will trust onEMPTY192.168.0.1,192.168.0.2
logsearch.auth.proxyuser.groupsList of user-groups which trusted-proxy user ‘knox’ can proxy for*admin,user
logsearch.auth.proxyuser.hostsList of hosts from which trusted-proxy user ‘knox’ can connect from*host1,host2
logsearch.auth.proxyuser.usersList of users which the trusted-proxy user ‘knox’ can proxy forknoxknox,hdfs
logsearch.auth.redirect.forwardForward redirects for HTTP calls. (useful in case of proxies)falsetrue
logsearch.auth.simple.enabledEnable simple authentication. That means you won't require password to log in.falsetruefalse
logsearch.auth.trusted.proxyA boolean property to enable/disable trusted-proxy ‘knox’ authenticationfalsetrue
logsearch.authr.file.enabledA boolean property to enable/disable file based authorizationfalsetrue
logsearch.authr.role.fileSimple file that contains user/role mappings.roles.jsonlogsearch-roles.json
logsearch.cert.algorithmAlgorithm to generate certificates for SSL (if needed).sha256WithRSAsha256WithRSA
logsearch.cert.folder.locationFolder where the generated certificates (SSL) will be located. Make sure the user of Log Search Server can access it./usr/lib/ambari-logsearch-portal/conf/keys/etc/mypath/keys
logsearch.config.api.enabledEnable config API feature and shipperconfig API endpoints.truefalse
logsearch.config.api.filter.solr.enabledUse solr as a log level filter storagefalsetrue
logsearch.config.api.filter.zk.enabledUse zookeeper as a log level filter storagefalsetrue
logsearch.config.zk_aclsZooKeeper ACLs for handling configs. (read & write)world:anyone:cdrwaworld:anyone:r,sasl:solr:cdrwa,sasl:logsearch:cdrwa
logsearch.config.zk_connect_stringZooKeeper connection string.EMPTYlocalhost1:2181,localhost2:2181/znode
logsearch.config.zk_connection_retry_time_out_msThe maximum elapsed time for connecting to ZooKeeper in milliseconds. 0 means retrying forever.EMPTY1200000
logsearch.config.zk_connection_time_out_msZooKeeper connection timeout in millisecondsEMPTY30000
logsearch.config.zk_rootZooKeeper root node where the shippers are stored. (added to the connection string)EMPTY/logsearch
logsearch.config.zk_session_time_out_msZooKeeper session timeout in millisecondsEMPTY60000
logsearch.hadoop.security.auth_to_localRules that will be applied on authentication names and map them into local usernames.DEFAULTRULE:[1:$1@$0](.*@EXAMPLE.COM)s/@.*//DEFAULT
logsearch.http.header.access-control-allow-credentialsAccess-Control-Allow-Credentials header for Log Search Server.truetruefalse
logsearch.http.header.access-control-allow-headersAccess-Control-Allow-Headers header for Log Search Server.origin, content-type, accept, authorizationcontent-type, authorization
logsearch.http.header.access-control-allow-methodsAccess-Control-Allow-Methods header for Log Search Server.GET, POST, PUT, DELETE, OPTIONS, HEADGET, POST
logsearch.http.header.access-control-allow-originAccess-Control-Allow-Origin header for Log Search Server.**http://c6401.ambari.apache.org
logsearch.http.portLog Search http port61888618888888
logsearch.https.portLog Search https port61889618898889
logsearch.jetty.access.log.enabledEnable jetty access logsfalsetrue
logsearch.login.credentials.fileName of the credential file which contains the users for file authentication (see: logsearch.auth.file.enabled).user_pass.jsonlogsearch-admin.json
logsearch.protocolLog Search Protocol (http or https)httphttphttps
logsearch.roles.allowedComma separated roles for external authentication.AMBARI.ADMINISTRATOR,CLUSTER.ADMINISTRATORAMBARI.ADMINISTRATOR
logsearch.session.timeoutLog Search http session timeout in minutes.30300
logsearch.solr.audit.logs.alias.nameAlias name for audit log collection (can be used for Log Search audit collection and ranger collection as well).audit_logs_aliasaudit_logs_alias
logsearch.solr.audit.logs.collectionName of Log Search audit collection.audit_logsaudit_logs
logsearch.solr.audit.logs.config.nameSolr configuration name of the audit collection.audit_logsaudit_logs
logsearch.solr.audit.logs.config_set.folderLocation of Log Search audit collection configs for Solr./usr/lib/ambari-logsearch-portal/conf/solr_configsets/usr/lib/ambari-logsearch-portal/conf/solr_configsets
logsearch.solr.audit.logs.numshardsNumber of Solr shards for audit collection (bootstrapping).12
logsearch.solr.audit.logs.replication.factorSolr replication factor for audit collection (bootstrapping).12
logsearch.solr.audit.logs.urlURL of Solr (non cloud mode) - currently unsupported.EMPTYlocalhost1:8868
logsearch.solr.audit.logs.zk.aclsList of Zookeeper ACLs for Log Search audit collection (Log Search and Solr must be able to read/write collection details)EMPTYworld:anyone:r,sasl:solr:cdrwa,sasl:logsearch:cdrwa
logsearch.solr.audit.logs.zk_connect_stringZookeeper connection string for Solr (used for audit log collection).EMPTYlocalhost1:2181,localhost2:2181/mysolr_znode
logsearch.solr.config_set.folderLocation of Solr collection configs./usr/lib/ambari-logsearch-portal/conf/solr_configsets/usr/lib/ambari-logsearch-portal/conf/solr_configsets
logsearch.solr.implicit.routingUse implicit routing for Solr Collections.falsetrue
logsearch.solr.implicit.routingUse implicit routing for Solr Collections.falsetrue
logsearch.solr.jaas.filePath of the JAAS file for Kerberos based Solr Cloud authentication./usr/lib/ambari-logsearch-portal/logsearch_solr_jaas.conf/my/path/jaas_file.conf
logsearch.solr.kerberos.enableEnable Kerberos Authentication for Solr Cloud.falsetruefalse
logsearch.solr.metadataName of Log Search metadata collection.logsearch_metadatalogsearch_metadata
logsearch.solr.metadata.config.nameSolr configuration name of the logsearch metadata collection.logsearch_metadatalogsearch_metadata
logsearch.solr.metadata.numshardsNumber of Solr shards for logsearch metadta collection (bootstrapping).23
logsearch.solr.metadata.replication.factorSolr replication factor for event metadata collection (bootstrapping).23
logsearch.solr.metadata.schema.fields.populate.interval.minsInterval in minutes for populating schema fiels for metadata collections.110
logsearch.solr.ranger.audit.logs.collectionName of Ranger audit collections (can be used if ranger audits managed by the same Solr which is used for Log Search).EMPTYranger_audits
logsearch.solr.service.logsName of Log Search service log collection.hadoop_logshadoop_logs
logsearch.solr.service.logs.config.nameSolr configuration name of the service log collection.hadoop_logshadoop_logs
logsearch.solr.service.logs.numshardsNumber of Solr shards for service log collection (bootstrapping).12
logsearch.solr.service.logs.replication.factorSolr replication factor for service log collection (bootstrapping).12
logsearch.solr.urlURL of Solr (non cloud mode) - currently unsupported.EMPTYlocalhost1:8868
logsearch.solr.zk.aclsList of Zookeeper ACLs for Log Search Collections (Log Search and Solr must be able to read/write collection details)EMPTYworld:anyone:r,sasl:solr:cdrwa,sasl:logsearch:cdrwa
logsearch.solr.zk_connect_stringZookeeper connection string for Solr.EMPTYlocalhost1:2181,localhost2:2181/mysolr_znode
logsearch.spnego.kerberos.enabledEnable SPNEGO based authentication for Log Search Server.falsetruefalse
logsearch.spnego.kerberos.hostlocalhostc6401.ambari.apache.orglocalhost
logsearch.spnego.kerberos.keytabKeytab for SPNEGO authentication for Http requests.EMPTY/etc/security/keytabs/mykeytab.keytab
logsearch.spnego.kerberos.principalPrincipal for SPNEGO authentication for Http requestsEMPTYmyuser@EXAMPLE.COM
logsearch.web.audit_logs.component.labelsMap of component component labels.ambari:Ambari,hdfs:Hdfs,RangerAudit:Rangerambari:Ambari,RangerAudit:ranger
logsearch.web.audit_logs.field.common.excludesList of fields that will be excluded from metadata schema responses for every audit components.tags,tags_str,seq_numreqUser,resp,tag_str
logsearch.web.audit_logs.field.common.filterable.common.excludesList of fields that will be excluded from filter selection on the UI for every audit components.EMPTYtag_str,resp,tag_str
logsearch.web.audit_logs.field.common.labelsMap of fields labels for audits (common).enforcer:Access Enforcer,access:Access Type,cliIP:Client Ip,cliType:Client Type,dst:DST,evtTime:Event Time,ip:IP,logtime:Log Time,sess:Session,ugi:UGI,reqUser:User,repo:Audit SourcereqUser:Req User,resp:Response
logsearch.web.audit_logs.field.common.visibleList of fields that will be displayed by default on the UI for every audit components.access,cliIP,evtTime,repo,resource,result,reqUserreqUser,resp
logsearch.web.audit_logs.field.excludesList of fields that will be excluded from metadata schema responses for different audit components.EMPTYambari:reqUser,resp,hdfs:ws_user,ws_role
logsearch.web.audit_logs.field.filterable.excludesList of fields that will be excluded from filter selection on the UI for different audit components.EMPTYambari:tag_str,resp,tag_str;RangerAudit:path,ip
logsearch.web.audit_logs.field.filterable.excludesEnable label fallback. (replace _ with spaces and capitalize properly)truefalse
logsearch.web.audit_logs.field.labelsMap of fields (key-value pairs) labels for different component types.EMPTYambari#reqUser:Ambari User,ws_response:Response;RangerAudit#reqUser:Req User
logsearch.web.audit_logs.field.visibleList of fields that will be displayed by default on the UI for different audit components.EMPTYambari:reqUser,resp;RangerAudit:reqUser,repo
logsearch.web.labels.service_logs.field.fallback.prefixesList of prefixes that should be removed during fallback of audit field labels.ws_,std_ws_,std_,sdi_
logsearch.web.labels.service_logs.field.fallback.prefixesList of prefixes that should be removed during fallback of service field labels.ws_,sdi_,std_ws_,std_,sdi_
logsearch.web.labels.service_logs.field.fallback.suffixesList of suffixes that should be removed during fallback of audit field labels._i,_l,_s,_b_i,_l,_s,_b
logsearch.web.labels.service_logs.field.fallback.suffixesList of suffixes that should be removed during fallback of service field labels._i,_l,_s,_b_i,_l,_s,_b
logsearch.web.service_logs.component.labelsMap of serivce component labels.EMPTYambari_agent:Ambari Agent,ambari_server:Ambari Servcer
logsearch.web.service_logs.field.excludesList of fields that will be excluded from metadata schema responses.id,tags,text,message,seq_num,case_id,bundle_id,rowtype,event_countseq_num,tag
logsearch.web.service_logs.field.filterable.excludesList of fields that will be excluded from filter selection on the UI.EMPTYpath,method,logger_name
logsearch.web.service_logs.field.labelsMap of serivce field labels.log_message:Message,type:Component,logtime:Log Time,thread_name:Threadlog_message:Message,ip:IP Address
logsearch.web.service_logs.field.visibleList of fields that will be displayed by default on the UI.log_message,level,logtime,typelog_message,path,logtime
logsearch.web.service_logs.group.labelsMap of serivce group labelsEMPTYambari:Ambari,yarn:YARN